Create email template

Create a new campaign email template owned by the authenticated caller's company. subject defaults to an empty string, template_type to regular, and template_editor_mode to custom when you omit it. The endpoint returns the saved row in full.

Auth

  • bearer token, account role — authentication (no throttle group). The template records company_id = user.person.company_id. store_id, if supplied, must belong to the caller's company hierarchy (an ownership check).

Rate limit

  • No rate limit.

Body

FieldTypeRequiredNotes
namestringRequiredMax 255. Must be unique among the caller's company templates and global (company_id NULL) templates.
subjectstringOptionalMax 255. Defaults to "".
store_idintegerOptionalScope the template to one store. Must be in the caller's company hierarchy (an ownership check).
template_typestringOptionalregular or follow_up. Defaults to regular.
template_editor_modestringOptionalcustom or html_editor. Defaults to custom.

Behaviour

  • Synchronous. 200 OK on success with the created model under data.data (note the double-data envelope). 422 when validation fails (e.g. duplicate name, store_id outside the caller's hierarchy).
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
string
string
string
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json