v1

latestOpenAPI 3.1.02026-07-2624070.9 KB

/campaigns

Create campaign where you will use your custom HTML template [Rate limited]

post/campaigns

Request body

typestring required

Type of campaign. Available values: regular, ab.

namestring required

The internal name for the campaign

groupsinteger[] required

IDs of groups. Required if segments are not specified.

segmentsinteger[] required

IDs of segments. Required if groups are not specified. If specified, groups are ignored. If you're using legacy subscriber management, this parameter will be ignored.

subjectstring

Mail subject. Required if campaign type is regular.

fromstring

Email of sender

from_namestring

Name of sender

languagestring
ab_settingsobject

Required if campaign type is ab. More details are below.

Response

200

campaign_typestring
datestring
account_idinteger
idinteger
mail_idinteger

Example response

{
  "campaign_type": "regular",
  "date": "2016-05-18 13:03:47",
  "account_id": 441087,
  "id": 3043021,
  "mail_id": 3529037,
  "options": {
    "current_step": "step3",
    "send_type": "regular",
    "campaign_type": "regular",
    "date": "2016-05-18 13:03:47"
  }
}
All 24 operations