Send a test email
/settings/emails/templates/{email_template_id}/test-messagesSends 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.
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
application/json
curl -X POST "https://example.com/settings/emails/templates/string/test-messages" \ -H "Content-Type: application/json" \ -d '{ "to": "user@example.com" }'{ "data": { "attempt": { "number": 0, "status": "running" }, "cancellation_requested": true, "created_at": "2019-08-24T14:15:22Z", "error": {}, "expires_at": "2019-08-24T14:15:22Z", "finished_at": "2019-08-24T14:15:22Z", "id": "string", "items_url": "string", "object": "operation", "progress": { "done": 0, "failed": 0, "total": 0 }, "result_url": "string", "started_at": "2019-08-24T14:15:22Z", "status": "queued", "type": "string" }}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.
Support settings
Next Page