Send campaign test email

Preview how a draft campaign looks in real inboxes by sending a test to up to five recipient email addresses. An optional contact_uid personalizes those emails and does not add a sixth recipient.

For regular campaigns, requires filled html, subject, and from address on the campaign. For A/B campaigns, require variant_id (regular/HTML variants only — plain-text variants return 422) and those fields on the selected variant. Allowed while under review. Subject to daily test-email limits on the account. Returns 422 for invalid status/content, recipients, or when limits are exceeded.

Path Params
string
required
Body Params
emails
array of strings, unique
required
length between 1 and 5

Recipient email addresses for the test (maximum 5 total).

emails*
string | null

Optional contact UID used to personalize the test emails. This does not count as or add a recipient.

integer | null

Required for A/B campaigns only (regular/HTML variant). Prohibited for regular campaigns.
Numeric id from show campaign variants[].id. Plain-text variants are not supported.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json