Save an email template
const url = 'https://apibase.ecomweb.app/api/v1/stores/example/email-templates/example';const options = { method: 'PUT', headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'}, body: '{"subject":"example","body_html":"example","body_text":"example","enabled":true}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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
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.
Whether this version is used when the email is sent. Defaults to true.
Responses
Section titled “Responses”object
Plain-text body, or null when the template has none.
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.
Template name.
Subject line, which may contain Handlebars variables.
HTML body fragment, which may contain Handlebars variables. It is placed inside the store-branded email layout.
Whether the store’s version is used when the email is sent.
True when this is the store’s saved version, false when it is the built-in default.
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.
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"}