Skip to main content

Get a specific campaign

Retrieve a specific campaign

GET https://api.cm.com/bulkemail/v1.0/accounts/{accountID}/campaigns/{campaignID}

GET Parameters​

NameInDescriptionRequiredTypeExample
AccountIDPathThe account guidTrueGUIDA8C062E4-ECFD-48D0-89B1-A37D2622B7A9
CampaignIDPathThe campaign guidTrueGUID77E6A0E6-0C92-4138-89BD-886EDF2ECC0D
IncludePreviewHtmlBodyQueryWhether to include a preview in the responseFalse (default False)BooleanTrue
X-CM-PRODUCTTOKENHeaderYour product tokenTrueGUIDC24A5029-37DD-4161-9728-F80D8639588E

Responses​

Http statusDescription
200Successful operation
400Bad request
Example response
{
"ID": "77e6a0e6-0c92-4138-89bd-886edf2ecc0d",
"AccountID": "a8c062e4-ecfd-48d0-89b1-a37d2622b7a9",
"Name": "Demo campaign",
"CampaignType": 1,
"CampaignState": 1,
"ToAddressListID": null,
"ScheduledOn": null,
"ScheduledOnUtc": null,
"TestPercentage": null,
"TestDurationMinutes": null,
"TestMetricType": null,
"SendToRemainingOn": null,
"SendToRemainingOnUtc": null,
"WinningVariationID": null,
"TotalRecipients": 0,
"PreviewHtmlBody": null,
"CampaignTags": [
{
"ID": "6eca6202-7a5a-4850-8800-cfee1d97d238",
"AccountID": "a8c062e4-ecfd-48d0-89b1-a37d2622b7a9",
"Tag": "Newsletter",
"CreatedOn": "2019-11-20T11:12:42.99",
"CreatedOnUtc": "2019-11-20T10:12:42.99Z",
"ModifiedOn": "2019-11-20T11:12:42.99",
"ModifiedOnUtc": "2019-11-20T10:12:42.99Z",
"DeletedOn": null,
"DeletedOnUtc": null
}
],
"GoogleAnalyticsTracking": null,
"LanguageConfiguration": {
"FallbackMailingID": "6eca6202-7a5a-4850-8800-cfee1d97d238",
"MailingLanguageConfigurations": {
"6eca6202-7a5a-4850-8800-cfee1d97d238": {
"languages": [
"nl-NL",
"nl-BE"
]
}
}
},
"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
}