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. Get statistics details
    4. Mail object definitions
  9. Unsubscriptions
    1. Get all unsubscriptions
    2. Create unsubscription
    3. Delete unsubscription
    4. Unsubscription object definition
  10. Webhooks
    1. Get webhook
    2. Create or update webhook
    3. Delete webhook
    4. Webhook object definition
    5. How to implement the webhook


Templates can be used in the frontend to reuse it for multiple mailings. The mailing object in the api also contains a template. These objects are the same.

Object definition template

Property Type Description
ID Guid The ID of the template
AccountID Guid The accountID of the template
Name String The name of the template
Description String The description of the template
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
Json String The json of the template. This field is only used when you use our editor. You can leave this blank.
MergeFields Object See mergefields object definition
CreatedOn DateTime When the template was created
ModifiedOn DateTime When the template was last modified
DeletedOn DateTime When the template was deleted

Object definition merge fields

Property Type Description
MergeTags Array of objects The mergetags available. See merge tag object definition
SpecialLinks Array of objects The special links available. See special link object definition

Object definition merge tag

Property Type Description
Name String The name of the merge tag
Value String The value of the merge tag. This is the placeholder that will be replaced in the body of the mail, for example: {{ Recipient.Url }}
Mapping String The field in the address object it should be replaced with, for example: Recipient.MergeFieldValue1.

Object definition special link

Property Type Description
Type String The of the link, this should be either system or link
Label String The label of the link. This is just for recognizing the link, it won't replace the label in the body.
Link String This is the placeholder in the body that will be replaced, for example [[ SpecialLink.link2 ]]
Link Mapping The url this link should map to, for example: https://www.cm.com. This can also be a merge field, for example: {{ Recipient.Url }}