{
  1. Intro
  2. From domains
    1. Get all from domains
    2. Get specific from domain
    3. Create from domain
    4. Verify from domain
    5. Delete from domain
    6. From domain object definition
  3. From addresses
    1. Get all from addresses
    2. Get specific from address
    3. Create from address
    4. Update from address
    5. Delete from address
    6. From address object definitions
  4. Address lists
  5. Templates
    1. Get all templates
    2. Get specific template
    3. Create template
    4. Update template
    5. Delete template
    6. Template object definitions
  6. Campaigns
    1. Get all campaigns
    2. Get specific campaign
    3. Create campaign
    4. Update campaign
    5. Delete campaign
    6. Clone campaign
    7. Get statistics
    8. Get clicks
    9. Get statistics details
    10. How to use triggered campaigns
    11. Campaign object definitions
  7. Mailings
    1. Get all mailings
    2. Get specific mailing
    3. Create mailing
    4. Update mailing
    5. Delete mailing
    6. Get statistics
    7. How to use merge fields
    8. Mailing object definitions
  8. Mails
    1. Create mail
    2. Create triggered mail
    3. Mail object definitions
  9. Unsubscriptions
    1. Get all unsubscriptions
    2. Create unsubscription
    3. Delete unsubscription
    4. Unsubscription object definition
  10. Campaign tags
    1. Get all campaign tags
    2. Get specific campaign tag
    3. Create campaign tag
    4. Update campaign tag
    5. Delete campaign tag
    6. Add campaign tag to campaign
    7. Delete campaign tag from campaign
    8. Campaign tag object
  11. Webhooks
    1. Get webhook
    2. Create or update webhook
    3. Delete webhook
    4. Webhook object definition
    5. How to implement the webhook

Mails

Send a mail without sending an entire campaign. You can choose from 2 options:

  • Use the create mail method when you want to send transactional mails or when you want to maintain the templates in your own system.
  • Use a triggered mail when you want to allow your colleagues to maintain the campaign in the CM.com platform. They will also be able to see the statuses of the specific campaign.

Object definition mail

Property Type Description
ID Guid The ID of the mail
AccountID Guid The accountID of the mail
FromAddressID Guid The ID of the from address you want to send with. Make sure this address is created as a sender first.
FromName String The from name to use in your mail. Leave null if you want to use the email address only.
ReplyToAddressID Guid The ID of the address you want the recipient to reply to when he clicks the reply button. Make sure this address is created as a sender first. Leave null to use the from address or the ReplyToAddress (when defined) as the reply to.
ReplyToAddress String The address you want the recipient to reply to when he clicks the reply button. This one will be overwritten when the ReplyToAddress is defined
ReplyToName String The name of the person to send a reply mail to. The ReplyToAddressID or ReplyToAddress should be defined when you fill the ReplyToName
ToAddress String The address to send your mail to
ToName String The name of the person to send your mail to
Ccs Object The Ccs for this mail. An array of email addresses needs to be passed. See the email address object definition. Keep in mind that every cc will count as an additional mail. When you have a cc it's impossible to know wheter the recipient or the person in the cc opened or clicked the mail.
Bccs Object The Bccs for this mail. An array of email addresses needs to be passed. See the email address object definition. Keep in mind that every bcc will count as an additional mail. When you have a bcc it's impossible to know wheter the recipient or the person in the bcc opened or clicked the mail.
Subject string The subject of your mail
HtmlBody String The html body of the template. This is the body that recipients with a normal e-mail client will get
TextBody String The text body of the template. This is the body that recipients will get when their e-mail client doesn't support HTML
Attachments Object The attachments for this mail. Attachments will not be returned in the response when sending a mail. See the attachment object definition.
CustomerReference String Your own reference. We will use this reference also in the status updates we will send to you when you have a webhook configured
CreatedOn DateTime When the mail was created
ModifiedOn DateTime When the mail was last modified

Object definition email address

Property Type Description
EmailAddress String the email address

Object definition attachment

Property Type Description
Content String The base64 encoded content of the attachment
FileName string The filename of the attachment, for example: "CalendarInvite.ics".
ContentID string The ContentID can be specified for images, to reference it in your image tag in your HTML. You can use "cid:yourcontentid" in the src tag of the image to display the image inline

Object definition triggered mail

Property Type Description
ID Guid The ID of the mail
AccountID Guid The accountID of the mail
CampaignID Guid The campaignID of the mail
ToAddress String The address to send your mail to
ToName String The name of the person to send your mail to
CustomValues Array of objects The custom values for this mail. See the custom values object definition.

Object definition custom value

Property Type Description
Field String The field name of the custom value. This name should correspond with the field name you entered in the campaign
Value String The value for the custom field. This will be the value that will be placed in the mail