Preview an email template
/settings/emails/templates/{email_template_id}/previewsRenders 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.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Path Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/settings/emails/templates/string/previews" \ -H "Content-Type: application/json" \ -d '{}'{ "data": { "html": "string", "object": "email_preview", "subject": "string", "template_id": "string" }}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.
Send a test email POST
Sends a test email using the template. The recipient in `to` must be the email address of an active administrator of the account or the configured sender address (`sender.address`). The email is sent asynchronously. The response contains the operation that tracks the delivery, and the `Location` header contains its URL.