Create split test campaign

Creates an email split test campaign. Pass a campaign name plus content arrays that define one or more variations.

Minimum required fields: name and plainTextContents. In practice, include at least one value in subjects, fromNames, htmlContents, and plainTextContents.

To run a split test, provide multiple values in one or more of these arrays: subjects, fromNames, fromAddresses, htmlContents, plainTextContents. Any field you are split-testing must have the same number of entries as the total number of variations.

Rules

  • Maximum 10 variations.
  • Array values cannot be blank.
  • fromAddresses must reference sender addresses that exist in your account.
  • replyAction, replyToAddress, and customReplyToAddress are optional.

Returns the created campaign, including its assigned id and current status.


This operation can be used to create a new split test email campaign within your account. You are able to split test on subject, from name, from address and both HTML and plain text versions of the campaign.

The numbers of variations must be equal for all specified properties. For example, if you supply 3 subject line variations, but only 2 from name variations, the campaign will fail validation.

If you don't specify a reply action, then 'Unset' is the default setting that you'll see in the result.

If you're using a 'reply to address', then replies will get stored both in-app and will also go to the 'reply to address' specified. This is also true of the 'WebMailForward' and 'WebMail' settings and thus you will not need to set these.

If you don't want replies to be stored in-app, then set the reply action to 'Delete' (thus they will be deleted). If you're using a 'reply to address' then replies will still go there.

Body Params
string
required
length ≤ 255

The campaign name.

subjects
array of strings

Subject line variations for split testing.

subjects
fromNames
array of strings

Sender name variations for split testing.

fromNames
fromAddresses
array of objects

Sender email address variations for split testing.

fromAddresses
htmlContents
array of strings

HTML content variations for split testing. Provide content that belongs inside the body of the email.

htmlContents
plainTextContents
array of strings
required

Plain text content variations for split testing.

plainTextContents*
string
enum

How recipient replies should be handled.

Allowed:
string

Email address that receives campaign replies.

string

Optional custom reply-to address, if enabled for your account.

Headers
string
/^(?:\{{0,1}(?:[0-9a-fA-F]){8}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){12}\}{0,1})$/

If you are a partner of Dotdigital and have a verified integration then include your integration tracking token here.

Responses

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