Preview an email template
const url = 'https://apibase.ecomweb.app/api/v1/stores/example/email-templates/example/preview';const options = { method: 'POST', headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'}, body: '{"subject":"example","body_html":"example","body_text":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”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.
The store’s ref, as returned by GET /stores.
Request Bodyrequired
Section titled “Request Bodyrequired”object
Subject line, which may contain Handlebars variables from the template’s variables list.
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.
Plain-text body, with the same variables as the HTML body.
Example generated
{ "subject": "example", "body_html": "example", "body_text": "example"}Responses
Section titled “Responses”object
The rendered plain-text email.
The rendered subject line.
The rendered HTML email.
Example generated
{ "text": "example", "subject": "example", "html": "example"}The request is malformed or failed validation.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The key is missing, invalid, revoked or expired.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
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.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The resource does not exist in this store.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}