CM.com's Campaigns API enables you to send campaigns to groups of recipients.
For individual and transactional messages, using the Business Messaging API is the preferred method. This Campaigns API is especially meant to send similar messages to a large group of recipients
The Campaigns API has some extra features which the Business Messaging API does not offer. You can check table below for features and the suggested API.
|Automatically Shorten URLs||Campaigns API|
|OptOut / Unsubscribe||Campaigns API|
|Schedule Campaigns||Campaigns API|
|Send CM Landing Page||Campaigns API with Mobile Marketing Cloud subscription / Basic|
|Send Personalized Campaigns to a group of recipients||Campaigns API with Mobile Marketing Cloud subscription / Basic|
|Send Event Notifications (Triggered campaigns)||Campaigns API with Mobile Marketing Cloud subscription / Basic|
|Spread send campaigns||Campaigns API with Mobile Marketing Cloud subscription / Advanced|
|No throttling||Business Messaging API|
|Encryption (configuration required)||Business Messaging API|
The Campaigns API is a REST API that uses JSON to communicate.
In getting started section current API functionality is described briefly. Some features like Analytics,Advanced Spread settings will be described separately.
Authentication and authorization is done via a product token. You can obtain your product token from the channels app (https://www.cm.com/app/channels/). If you don't see that app you might have got it via your account manager or you can contact support to obtain one.
For all methods described in this api, the product token should be provided by including it in the X-CM-PRODUCTTOKEN header.
Getting your accountID
In all methods you need to provide the accountID. This is a guid that identifies your account. This identifier can be found on the url of the addressbook application (https://www.cm.com/app/campaigns/), after the language indicator. Below you can find some url examples and the corresponding accountID.
In below section current API functionality within initial release is described briefly. Some features like Analytics, Advanced Spread settings will be available later but they are included in request/response models.
Updated 7 months ago