Skip to main content
CampaignsVersion: v3New

Test Send Email Campaign

POST/emails/locations/{locationId}/campaigns/emails/{campaignId}/test

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

Authorizationstringheaderrequired

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

Scope:emails/campaigns.write
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Idempotency-Keystring

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.

Example:0f8fad5b-d9cb-469f-a165-70867728950e
Versionstringrequired

API Version

Available optionsv3
Example:v3

Path Parameters

locationIdstringrequired

Location ID

Example:ve9EPM428h8vShlRW1KT
campaignIdstringrequired

Campaign ID

Example:67f15c2ae99226d5bcccb8f3

Body

subjectstring

Subject to use for this request. Omit to use the stored subject; an empty string fails send validation.

Example:Holiday sale starts now
fromNamestring

Sender display name for this request. Defaults to the stored sender name; empty string omits the display name.

Example:Anz Studio
fromEmailstring

Sender email address for this request. Must be a valid email address. Defaults to the stored fromAddress.

emailsstring[]required

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

Example:["[email protected]"]
userIdstring

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.

Example:wlZTJPotcy10MZxNiwLK
variationIndexnumber

A/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

Example:1

Response

Success

acceptedbooleanrequired

True when the test was accepted for sending. This does not confirm delivery.

Example:true
recipientsstring[]required

Recipient addresses the test was sent to.

Example:["[email protected]"]
notestringrequired

Delivery caveat.

Example:Accepted for sending; delivery is not confirmed. Merge fields are filled with sample contact data, not the real recipient values.