Skip to content

Preview an email template

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

Renders an unsaved subject and body with the store’s branding and sample data, applying the same checks as a save, and returns the result. Nothing is saved and no email is sent.

Required scopes: read: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

Example generated

{
"subject": "example",
"body_html": "example",
"body_text": "example"
}
Media typeapplication/json
object
text

The rendered plain-text email.

string
subject

The rendered subject line.

string
html
required

The rendered HTML email.

string

Example generated

{
"text": "example",
"subject": "example",
"html": "example"
}

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"
}