Create an email template

Create a new email template, to set up a campaign's email. You'll need a name. The subject is optional, and the body isn't set here: add it with POST /api/v1/campaign/template/email/update. Returns the template with its id.

Prerequisites: a bearer token. Optional: a location id (store_id) to tie the template to one location.

Authentication: Account token. The template is saved under the account of the user behind the token. store_id, when sent, must be a location inside your own account tree; otherwise 422.

Rate limit: none.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
Defaults to Welcome Email Template

The template's name, up to 255 characters. Must be unique among your account's templates and the shared (global) templates.

string
Defaults to Welcome to our service!

The email subject line, up to 255 characters. Defaults to an empty string.

integer
Defaults to 3007

A location to tie the template to. Must be inside your account tree.

string
enum
Defaults to regular

regular or follow_up. Defaults to regular. A follow_up template becomes a campaign's follow-up email when you attach it to a channel.

Allowed:
string
enum
Defaults to custom

The editor used to author the template: custom or html_editor. Defaults to custom.

Allowed:
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