Developers
Email settings

Retrieve an email template

GET/settings/emails/templates/{email_template_id}

Retrieves an email template by its key. The template catalog is fixed and contains sale, import, free, and new_access.

The response includes an ETag representing the current revision. Send this value in the If-Match header when updating the template to avoid overwriting a newer version.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Path Parameters

email_template_id*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/settings/emails/templates/string"
{  "data": {    "body": "string",    "editable": true,    "enabled": true,    "id": "sale",    "include_credentials": true,    "name": "string",    "object": "email_template",    "revision": "string",    "variables": [      {        "description": "string",        "name": "string"      }    ]  }}

List email templates GET

Returns the complete email template catalog in a single response. The catalog is fixed: templates cannot be created or deleted.

Update an email template PATCH

Updates an email template. Only the fields included in the request are changed. `body` can be changed only on editable templates. Sending `body` for the `new_access` template is rejected as invalid data. To avoid overwriting a newer version, send the `ETag` returned by the retrieve operation in the `If-Match` header. The header is optional; when it is omitted, the update is applied to the current revision.