Skip to main content
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 contactProperties and eventProperties.
  • Transactional accepts dataVariables.
Supplying a field the parent cannot reference results in a 400 Bad Request error. Each team can send up to 100 preview emails per day.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

emailMessageId
string
required

The ID of the email message.

Body

application/json
emails
string[]
required

One or more addresses to send the preview to.

Minimum array length: 1
contactProperties
object

Contact property values to render. Accepted for campaign and workflow previews.

eventProperties
object

Event property values to render. Accepted for workflow previews only.

dataVariables
object

Transactional data variables to render. Accepted for transactional previews only.

Response

Preview scheduled.

id
string
required

The ID of the email message the preview was sent for.

Last modified on July 20, 2026