Create split test campaign

post

https://{region}-api.dotdigital.com/v2/campaigns/split-test

Creates a split test campaign

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

name

string

required

The name of the campaign being created

subjects

array of strings

The name of the split test campaign being created

subjects

fromNames

array of strings

The from names to be split tested on

fromNames

fromAddresses

array of objects

The emails of existing custom from addresses to be split tested on

fromAddresses

htmlContents

array of strings

The HTML contents of the campaign that lies between the opening and the closing only (the tags themselves should not be used), to be split tested on

htmlContents

plainTextContents

array of strings

The plain text contents of the campaign, to be split tested on

plainTextContents

replyAction

string

enum

The required action to be taken when a reply to the campaign is sent by the recipient

Allowed:

replyToAddress

string

The email address that you would like replies to be forwarded to

Headers

x-ddg-integration-token

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.

Response

200200