Skip to content

Save an email template

PUT
/stores/{storeRef}/email-templates/{name}
curl --request PUT \
--url https://apibase.ecomweb.app/api/v1/stores/example/email-templates/example \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--data '{ "subject": "example", "body_html": "example", "body_text": "example", "enabled": true }'

Saves the store’s own subject and body for a template, replacing any earlier version, and returns what was saved. The body is sanitized and may only use the variables listed for the template. A body that fails the check is refused with 400 and one of TEMPLATE_INVALID_SYNTAX, TEMPLATE_FORBIDDEN_CONSTRUCT, TEMPLATE_UNKNOWN_VARIABLE or TEMPLATE_TOO_LARGE.

Required scopes: write:settings

name
required
string

The template name: auth-verify-email, auth-otp-login, auth-reset-password, auth-password-changed, auth-welcome, auth-change-email, order-confirmation, order-shipped, order-delivered and review-invitation.

storeRef
required
string

The store’s ref, as returned by GET /stores.

Media typeapplication/json
object
subject
required

Subject line, which may contain Handlebars variables from the template’s variables list.

string
<= 200 characters
body_html
required

HTML body fragment, which may contain Handlebars variables from the template’s variables list. It is placed inside the store-branded email layout and sanitized before it is saved.

string
<= 65536 characters
body_text

Plain-text body, with the same variables as the HTML body.

string
nullable <= 65536 characters
enabled

Whether this version is used when the email is sent. Defaults to true.

boolean
default: true
Media typeapplication/json
object
body_text
required

Plain-text body, or null when the template has none.

string
nullable
variables
required

The variables the subject and bodies may reference, such as store.name or reset_url. A template that uses any other variable cannot be saved.

Array<string>
template_name
required

Template name.

string
subject
required

Subject line, which may contain Handlebars variables.

string
body_html
required

HTML body fragment, which may contain Handlebars variables. It is placed inside the store-branded email layout.

string
enabled
required

Whether the store’s version is used when the email is sent.

boolean
is_customized
required

True when this is the store’s saved version, false when it is the built-in default.

boolean

Example generated

{
"body_text": "example",
"variables": [
"example"
],
"template_name": "example",
"subject": "example",
"body_html": "example",
"enabled": true,
"is_customized": true
}

The request is malformed or failed validation.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key is missing, invalid, revoked or expired.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key may not do this: a missing scope, a readonly key, a publishable key on a Store API route, or a disallowed origin.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The resource does not exist in this store.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}