Send campaign test email

Render the campaign draft and email it to up to 5 recipients so the merchant (or their AI tool) can preview it without leaving the API. The test uses the campaign's saved subject, sender, and content; only email campaigns are supported.

Scopes:
campaigns.write

Path Params
string
required

Campaign ID (24 character hexadecimal)

Body Params

Test email recipients

Request payload for sending a campaign test email.

recipients
array of strings
required
length between 1 and 5

Email addresses that receive the test send. Between 1 and 5 addresses.

recipients*
Headers
string
required
Defaults to 2026-preview

API version that specifies the response format and behaviour

Responses
204

Test email queued for delivery

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