Update an email template
/settings/emails/templates/{email_template_id}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.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Path Parameters
Header Parameters
Client-generated key that makes the request safe to retry. Must be 1 to 128 characters from [A-Za-z0-9._:-]. Optional on this operation; when sent, a malformed key returns idempotency_key_invalid, and repeating the request with the same key and the same body returns the stored result with Idempotent-Replayed: true.
Expected revision of the resource, in the same format as the ETag header (W/"<type>:<id>:<revision>"). If the resource has changed since that revision, the request fails with 412 and the revision_mismatch error code. When omitted, the update is applied to the current revision.
Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.
length <= 64Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/settings/emails/templates/string" \ -H "Content-Type: application/json" \ -d '{}'{ "data": { "body": "string", "editable": true, "enabled": true, "id": "sale", "include_credentials": true, "name": "string", "object": "email_template", "revision": "string", "variables": [ { "description": "string", "name": "string" } ] }}Retrieve an email template GET
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 of this template; changes to other templates or settings groups do not affect it. Send this value in the `If-Match` header when updating the template to avoid overwriting a newer version.
Preview an email template POST
Renders an email template with an optional draft `body` and returns the resulting subject and HTML. Nothing is saved, so this operation can be used to review changes before updating the template. Requires only the `settings.read` permission. The `new_access` template does not support previews.