Update a Mailing

Update a mailing

Update a mailing.

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

PUT Parameters

Name In Description Required Type Example
AccountID Path The account guid True Guid A8C062E4-ECFD-48D0-89B1-A37D2622B7A9
CampaignID Path The mailing guid True Guid 77E6A0A6-0C92-4138-89BD-886EDF2RCC0D
MailingID Path The mailing guid True Guid B6D33812-24CC-48E3-B7DD-354715051A85
Body Body The mailing to update True Json object See example request
X-CM-PRODUCTTOKEN Header Your product token True Guid C24A5029-37DD-4161-9728-F80D8639588E
{
    "Name": "Demo",
    "FromName": "John Doe",
    "FromAddressID": "05923f4c-eb2e-4e4b-a07a-096fcbb2697a",
    "ReplyToAddressID": null,
    "Subject": "Demo",
    "MailingState": 2,
    "ScheduledOn": null,
    "MailingType": 1,
    "Template": {
        "Name": "Demo Template",
        "Description": "Demo description",
        "HtmlBody": "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional //EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\"><html><body><p> Hello {{ Recipient.Name }}</p></body></html>",
        "TextBody": "Hello {{ Recipient.Name }}",
        "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"
                }
            ]
        },
        "TemplateEditorType": 2
    }
}

Responses

Http status Description
200 Mailing updated
400 Bad request
{
    "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,
    "ScheduledOn": null,
    "MailingType": 1,
    "Template": {
        "ID": "dfd26818-88e9-4d1a-8a79-20ce44ea12fa",
        "AccountID": "a8c062e4-ecfd-48d0-89b1-a37d2622b7a9",
        "Name": "Demo Template",
        "Description": "Demo description",
        "HtmlBody": "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional //EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\"><html><body><p> Hello {{ Recipient.Name }}</p></body></html>",
        "TextBody": "Hello {{ Recipient.Name }}",
        "Json": null,
        "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-08T15:25:40.995",
        "CreatedOnUtc": "2017-08-08T14:25:40.995Z",
        "ModifiedOn": "2017-08-08T15:25:40.995",
        "ModifiedOnUtc": "2017-08-08T14:25:40.995Z",
        "DeletedOn": null,
        "DeletedOnUtc": null
    },
    "CreatedOn": "2017-08-08T15:25:40.995",
    "CreatedOnUtc": "2017-08-08T14:25:40.995Z",
    "ModifiedOn": "2017-08-08T15:25:40.995",
    "ModifiedOnUtc": "2017-08-08T14:25:40.995Z",
    "DeletedOn": null,
    "DeletedOnUtc": null
}

Did this page help you?