{

Get a specific mailing

Retrieve a specific mailing

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

GET Parameters

Name In Description Required Type Example
AccountID Path The account guid True Guid A8C062E4-ECFD-48D0-89B1-A37D2622B7A9
MailingID Path The mailing guid True Guid B6D33812-24CC-48E3-B7DD-354715051A85
IncludeTemplateHtmlBody Query Whether to include the html body of the template in the response False (default True) Bool True
IncludeTemplateTextBody Query Whether to include the text body of the template in the response False (default True) Bool True
IncludeTemplateJson Query Whether to include the template json of the template in the response False (default True) Bool True
X-CM-PRODUCTTOKEN Header Your product token True Guid C24A5029-37DD-4161-9728-F80D8639588E

Responses

Http status Description Example
200 Successful operation { "ID": "4ae21153-5dc0-4e35-9497-c87b7a3f6653", "AccountID": "a8c062e4-ecfd-48d0-89b1-a37d2622b7a9", "Name": "Demo", "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": "Subscribe", "Link": "[[ SpecialLink.Subscribe ]]", "Mapping": "SpecialLink.Subscribe" }, { "Type": "system", "Label": "View in browser", "Link": "[[ SpecialLink.ViewInBrowser ]]", "Mapping": "SpecialLink.ViewInBrowser" }, { "Type": "system", "Label": "Viewed", "Link": "[[ SpecialLink.Pixel ]]", "Mapping": "SpecialLink.Pixel" } ] }, "CreatedOn": "2017-08-08T14:50:30.413", "ModifiedOn": "2017-08-08T14:50:30.413", "DeletedOn": null }, "FromName": "John Doe", "FromAddressID": "05923f4c-eb2e-4e4b-a07a-096fcbb2697a", "Subject": "Demo", "ToAddressListID": "3de57f95-9d82-48f6-8173-9492df295615", "MailingState": 2, "ScheduledOn": null, "TotalRecipients": 1, "MailingType": 1, "CreatedOn": "2017-08-08T14:50:30.413", "ModifiedOn": "2017-08-08T14:50:30.413", "DeletedOn": null }
400 Bad request

Try it out