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

Get all campaigns

Retrieve all the campaigns available for your account

GET https://api.cm.com/bulkemail/v1.0/accounts/{accountID}/campaigns

GET Parameters

Name In Description Required Type Example
AccountID Path The account guid True Guid A8C062E4-ECFD-48D0-89B1-A37D2622B7A9
Skip Query The amount of campaigns to skip False (default 0) Int 0
Take Query The amount of campaigns to take False (default 1000) Int 1000
Filter Query The name to filter on False String My awesome campaign
CampaignTypeID Query The campaign type to filter on. See also campaign object definition for possible values False Int 1
CampaignTags Query The tagnames to filter on False String Newsletter
IncludePreviewHtmlBody Query Whether to include a preview in the response False (default False) Bool True
X-CM-PRODUCTTOKEN Header Your product token True Guid C24A5029-37DD-4161-9728-F80D8639588E


Http status Description Example
200 Successful operation [ { "ID": "77e6a0e6-0c92-4138-89bd-886edf2ecc0d", "AccountID": "a8c062e4-ecfd-48d0-89b1-a37d2622b7a9", "Name": "Demo campaign", "CampaignType": 1, "CampaignState": 1, "ToAddressListID": null, "ScheduledOn": null, "ScheduledOnUtc": null, "TestPercentage": null, "TestDurationMinutes": null, "TestMetricType": null, "SendToRemainingOn": null, "SendToRemainingOnUtc": null, "WinningVariationID": null, "TotalRecipients": 0, "PreviewHtmlBody": null, "CampaignTags": [ { "ID": "6eca6202-7a5a-4850-8800-cfee1d97d238", "AccountID": "a8c062e4-ecfd-48d0-89b1-a37d2622b7a9", "Tag": "Newsletter", "CreatedOn": "2019-11-20T11:12:42.99", "CreatedOnUtc": "2019-11-20T10:12:42.99Z", "ModifiedOn": "2019-11-20T11:12:42.99", "ModifiedOnUtc": "2019-11-20T10:12:42.99Z", "DeletedOn": null, "DeletedOnUtc": null } ], "GoogleAnalyticsTracking": null, "CreatedOn": "2019-03-27T15:13:45.127", "CreatedOnUtc": "2019-03-27T14:13:45.127Z", "ModifiedOn": "2019-03-27T15:13:45.127", "ModifiedOnUtc": "2019-03-27T14:13:45.127Z", "DeletedOn": null, "DeletedOnUtc": null } ]
400 Bad request

Try it out