Create a Campaign
Create a campaign
Create a new campaign
POST https://api.cm.com/bulkemail/v1.0/accounts/{accountID}/campaigns
POST Parameters
Name | In | Description | Required | Type | Example |
---|---|---|---|---|---|
AccountID | Path | The account guid | True | GUID | A8C062E4-ECFD-48D0-89B1-A37D2622B7A9 |
Body | Body | The campaign to create | True | Json object | See example request |
X-CM-PRODUCTTOKEN | Header | Your product token | True | GUID | C24A5029-37DD-4161-9728-F80D8639588E |
{
"Name": "Demo campaign",
"CampaignType": 1,
"CampaignState": 1,
"ToAddressListID": "3de57f95-9d82-48f6-8173-9492df295615",
"ScheduledOnUtc": null,
"TestPercentage": 0.10,
"TestDurationMinutes": 240,
"TestMetricType": 1
}
Responses
Http status | Description |
---|---|
201 | Campaign created |
400 | Bad request |
{
"ID": "77e6a0e6-0c92-4138-89bd-886edf2ecc0d",
"AccountID": "a8c062e4-ecfd-48d0-89b1-a37d2622b7a9",
"Name": "Demo campaign",
"CampaignType": 1,
"CampaignState": 1,
"ToAddressListID": "3de57f95-9d82-48f6-8173-9492df295615",
"ScheduledOn": null,
"ScheduledOnUtc": null,
"TestPercentage": 0.1,
"TestDurationMinutes": 240,
"TestMetricType": 1,
"SendToRemainingOn": null,
"SendToRemainingOnUtc": null,
"WinningVariationID": null,
"TotalRecipients": 1,
"PreviewHtmlBody": null,
"CampaignTags": null,
"GoogleAnaylyticsTracking": null,
"LanguageConfiguration": null,
"CreatedOn": "2019-03-27T15:13:45.127",
"CreatedOnUtc": "2019-03-27T14:13:45.127Z",
"ModifiedOn": "2019-03-27T15:13:45.127",
"ModifiedOnUtc": "2019-03-27T14:13:45.127Z",
"DeletedOn": null,
"DeletedOnUtc": null
}
Updated 9 months ago