Skip to main content

Get a specific mailing

Retrieve a specific mailing

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

GET Parameters​

NameInDescriptionRequiredTypeExample
AccountIDPathThe account guidTrueGuidA8C062E4-ECFD-48D0-89B1-A37D2622B7A9
CampaignIDPathThe campaign guidTrueGuid77E6A0E6-0C92-4138-89BD-886EDF2ECC0D
MailingIDPathThe mailing guidTrueGuidB6D33812-24CC-48E3-B7DD-354715051A85
IncludeTemplateHtmlBodyQueryWhether to include the html body of the template in the responseFalse (default True)BoolTrue
IncludeTemplateTextBodyQueryWhether to include the text body of the template in the responseFalse (default True)BoolTrue
IncludeTemplateJsonQueryWhether to include the template json of the template in the responseFalse (default True)BoolTrue
X-CM-PRODUCTTOKENHeaderYour product tokenTrueGuidC24A5029-37DD-4161-9728-F80D8639588E

Responses​

Http statusDescription
200Successful operation
400Bad request
Example response
{
"ID": "b6d33812-24cc-48e3-b7dd-354715051a85",
"AccountID": "a8c062e4-ecfd-48d0-89b1-a37d2622b7a9",
"CampaignID": "77e6a0e6-0c92-4138-89bd-886edf2ecc0d",
"Name": "Demo",
"FromName": "John Doe",
"FromAddressID": "05923f4c-eb2e-4e4b-a07a-096fcbb2697a",
"ReplyToAddressID": null,
"Subject": "Demo",
"MailingState": 2,
"MailingType": 1,
"Template": {
"ID": "d20a579e-c14a-41d5-87f3-cb84073c699e",
"AccountID": "a8c062e4-ecfd-48d0-89b1-a37d2622b7a9",
"Name": "campaignTemplate",
"Description": "campaignDescription",
"HtmlBody": "Omitted for clarity",
"TextBody": "[[ SpecialLink.ViewInBrowser ]]\n\nI'm a new Text block ready for your content.\n\n[[ SpecialLink.Unsubscribe ]]",
"Json": "Omitted for clarity",
"MergeFields": {
"MergeTags": [
{
"Name": "Recipient.Name",
"Value": "{{ Recipient.Name }}",
"Mapping": "Recipient.MergeFieldValue1"
},
{
"Name": "Sender.EmailAddress",
"Value": "{{ Sender.EmailAddress }}",
"Mapping": "Sender.EmailAddress"
},
{
"Name": "Recipient.EmailAddress",
"Value": "{{ Recipient.EmailAddress }}",
"Mapping": "Recipient.EmailAddress"
}
],
"SpecialLinks": [
{
"Type": "system",
"Label": "Unsubscribe",
"Link": "[[ SpecialLink.Unsubscribe ]]",
"Mapping": "SpecialLink.Unsubscribe"
},
{
"Type": "system",
"Label": "View in browser",
"Link": "[[ SpecialLink.ViewInBrowser ]]",
"Mapping": "SpecialLink.ViewInBrowser"
},
{
"Type": "system",
"Label": "Viewed",
"Link": "[[ SpecialLink.Pixel ]]",
"Mapping": "SpecialLink.Pixel"
}
]
},
"TemplateEditorType": 2,
"CreatedOn": "2017-08-08T14:50:30.413",
"CreatedOnUtc": "2017-08-08T13:50:30.413Z",
"ModifiedOn": "2017-08-08T14:50:30.413",
"ModifiedOnUtc": "2017-08-08T13:50:30.413Z",
"DeletedOn": null,
"DeletedOnUtc": null
},
"CreatedOn": "2017-08-08T14:50:30.413",
"CreatedOnUtc": "2017-08-08T13:50:30.413Z",
"ModifiedOn": "2017-08-08T14:50:30.413",
"ModifiedOnUtc": "2017-08-08T13:50:30.413Z",
"DeletedOn": null,
"DeletedOnUtc": null
}