Test Send Email Campaign
Send this campaign as a test to one to five email addresses: version A, or the A/B version picked with variationIndex (1 = B, 2 = C, ...), with the saved campaign subject and sender unless overridden; merge fields are filled with sample contact data, not the real recipient values. Limited to 20 test requests per location per hour, shared with template tests. Send an Idempotency-Key so a retry does not send twice. Acceptance does not confirm delivery.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your access token.
emails/ campaigns. writeOAuthPrivate IntegrationSub-Account TokenRequest
Headers
Unique key per intended write (max 255 chars). Retrying with the same key and body within 24 hours returns the first response instead of creating another resource. Reusing the key with a different body returns 422; a retry while the first request is still running returns 409.
0f8fad5b-d9cb-469f-a165-70867728950eAPI Version
v3v3Path Parameters
Location ID
ve9EPM428h8vShlRW1KTCampaign ID
67f15c2ae99226d5bcccb8f3Body
Subject to use for this request. Omit to use the stored subject; an empty string fails send validation.
Holiday sale starts nowSender display name for this request. Defaults to the stored sender name; empty string omits the display name.
Anz StudioSender email address for this request. Must be a valid email address. Defaults to the stored fromAddress.
[email protected]One to 5 recipient addresses (any inbox, for example a QA or client address). Limited to 20 test requests per location per hour.
Possible values: >= 1, <= 5
["[email protected]"]Active user of this location the test is sent as (conversations requires one). Defaults to the token user; required when the token has no user (location and MCP tokens), so look it up with Search Users.
wlZTJPotcy10MZxNiwLKA/B version to test-send: 1 = version B, 2 = version C, ... (see abVersions in Get Email Campaign). Omit for version A, the campaign itself. 404 when that version does not exist; nothing is created.
Possible values: >= 1 and <= 9
1Response
Success
True when the test was accepted for sending. This does not confirm delivery.
trueDelivery caveat.
Accepted for sending; delivery is not confirmed. Merge fields are filled with sample contact data, not the real recipient values.