Send a preview of an email message
Email messages
Send a preview of an email message
Send a test preview of an email message to one or more addresses.
POST
Send a preview of an email message
Send a test email message to one or more addresses. Accepted variable fields depend on the parent’s type:
- Campaign accepts
contactProperties. - Workflow accepts
contactPropertiesandeventProperties. - Transactional accepts
dataVariables.
400 Bad Request error.
Each team can send up to 100 preview emails per day.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The ID of the email message.
Example:
"cle5f7g9h1i3j5k7l9m1n3p5"
Body
application/json
One or more addresses to send the preview to.
Minimum array length:
1Contact property values to render. Accepted for campaign and workflow previews.
Example:
Event property values to render. Accepted for workflow previews only.
Example:
Transactional data variables to render. Accepted for transactional previews only.
Example:
Response
Preview scheduled.
The ID of the email message the preview was sent for.
Example:
"cle5f7g9h1i3j5k7l9m1n3p5"
Last modified on July 20, 2026
Related topics
Email messagesTransactional email API examplesCampaigns API examplesSend a transactional emailCreate a campaign
