{
  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

Mailings

Send a mailing by creating a mailing object. A mailing can also be saved and send later and a mailing can also be scheduled to be send later. Keep in mind that you have to send to good quality address lists. If your mailing is causing more than 5% permanent bounces, we will stop your mailing. This is because we want to prevent spamming and sending mail to random persons that don't want to receive your mailing.

Object definition mailing

Property Type Description
ID Guid The ID of the mailing
AccountID Guid The accountID of the mailing
Name String The name of the mailing
Template Object The template for this mailing. See the template object definition
FromName String The from name to use in your mailing. Leave null if you want to use the email address only.
FromAddressID Guid The ID of the from address you want to send with. Make sure this address is verified first.
Subject String The subject of your mailing. The subject can include merge fields as well, for example: Hi {{ Recipient.FirstName }}, see this awesome mail!
MailingState Int (Enum) The state of the mailing
1 = Saved, mailing is saved and can be send later.
2 = Ready for sending, mailing will be send right away or on the scheduled date.
3 = Picked up by queuer, this mailing is currently being picked up to send.
4 = Processed, this mailing has been processed.
5 = Stopped, this mailing has been stopped due to a too high bounce or complaint rate.
6 = OutOfCredits, this mailing has been stopped due to not having enough credits for sending the emails.
MailingType Int (Enum) The type of the mailing
1 = Newsletter mailing
2 = Test campaign
3 = Triggered mailing
4 = Test triggered
5 = AB test variation
6 = AB test result
CreatedOn DateTime When the mailing was created
ModifiedOn DateTime When the mailing was last modified
DeletedOn DateTime When the mailing was deleted

Object definition statistics

Property Type Description
MailingID Guid The ID of the mailing
Total Int Total number of recipients
Statistics Array of object Statistiscs per state, see statistic object definition

Object definition statistic

Property Type Description
StatusID Int The ID of status
Status String The name of the status
NumberOfItems Int Number of items with this status