Create a Mail
Create a mail
Create a mail without creating a campaign. Before starting to send mails, make sure you have created a from address. See the from addresses section to create and obtain from addresses.
POST https://api.cm.com/bulkemail/v1.0/accounts/{accountID}/mails
System links
The following system links can be included for a mail without a campaign. Simply put the placeholder somewhere in the body of the mail and we will automatically replace them.
Placeholder | Description |
---|---|
[[ SpecialLink.Unsubscribe ]] | Unsubscribe link, this will allow users to unsubscribe for your mails. They won't get mails when you try to send to them again. |
POST Parameters
Name | In | Description | Required | Type | Example |
---|---|---|---|---|---|
AccountID | Path | The account guid | True | Guid | A8C062E4-ECFD-48D0-89B1-A37D2622B7A9 |
Body | Body | The mail to create | True | Json object | See example request |
X-CM-PRODUCTTOKEN | Header | Your product token | True | Guid | C24A5029-37DD-4161-9728-F80D8639588E |
{
"FromAddressID": "05923f4c-eb2e-4e4b-a07a-096fcbb2697a",
"FromName": "John Doe",
"ReplyToAddressID": null,
"ReplyToAddress": null,
"ReplyToName": null,
"ToAddress": "[email protected]",
"ToName": "John Doe",
"Ccs": [
{
"EmailAddress": "[email protected]"
}
],
"Bccs": null,
"Subject": "Demo",
"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 John!</p><a href=\"[[ SpecialLink.Unsubscribe ]]\">Unsubscribe</a></body></html>",
"TextBody": "Hello John",
"Attachments": [
{
"Content": "VGhpcyBpcyBhIGF3ZXNvbWUgdGV4dCBmaWxl",
"FileName": "info.txt"
}
],
"CustomerReference": "123456789"
}
Responses
Http status | Description |
---|---|
200 | Mail created |
400 | Bad request |
{
"ID": "16bc0f8e-77af-4cfa-a2d0-686726d1f697",
"AccountID": "a8c062e4-ecfd-48d0-89b1-a37d2622b7a9",
"FromAddressID": "05923f4c-eb2e-4e4b-a07a-096fcbb2697a",
"FromName": "John Doe",
"ReplyToAddressID": null,
"ReplyToAddress": null,
"ReplyToName": null,
"ToAddress": "[email protected]",
"ToName": "John Doe",
"Ccs": [
{
"EmailAddress": "[email protected]"
}
],
"Bccs": null,
"Subject": "Demo",
"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 John!</p><a href=\"[[ SpecialLink.Unsubscribe ]]\">Unsubscribe</a></body></html>",
"TextBody": "Hello John",
"Attachments": null,
"CreatedOn": "2017-08-22T16:30:09.899",
"CreatedOnUtc": "2017-08-22T15:30:09.899Z",
"ModifiedOn": "2017-08-22T16:30:09.899",
"ModifiedOnUtc": "2017-08-22T15:30:09.899Z"
}
Updated 9 months ago