Category
Marketing
Marketing
List of Campaigns
Retrieve a list of Campaign objects Parameter Accessible via URL https://api.channel.io/open/v5/mkt/campaigns and HTTP GET Parameter Example Required Description Parameter Type since 1605795977290 Optional Epoch time in microseconds of the first Campaign to be retrieved. Pagination is supported along with the next value contained in the root object of the JSON response. Query limit 25 Optional Restrict the maximum number of results - min : 1 - max : 500 - default : 25 Query states active Optiona
Get a single Campaign
Get a particular Campaign object Parameter Accessible via URL https://api.channel.io/open/v5/mkt/campaigns/{id} and HTTP GET Parameter Example Required Description Parameter Type id 1234 Required ID of Campaign object Path Example GET https://api.channel.io/open/v5/mkt/campaigns/1234 Response Returns a Campaign object and a list of CampaignMsg objects along with related information { "campaign": { "id": "string", "channelId": "string", "name": "string", "state": "draft", "sendMedium": "appAlimta
List of Campaign Users
Retrieve a list of Campaign User objects Parameter Accessible via URL https://api.channel.io/open/v5/mkt/campaigns/{id}/campaign-users and HTTP GET Parameter Example Required Description Parameter Type id 1234 Required ID of Campaign object Path state sent Required The type of Campaign User objects to be retrieved. - available values : sent, view, goal, click Query since eyJjaGF0S2V5IjoiZ3Jvn0= Optional Encoded key of the first Campaign User to be retrieved. Pagination is supported along with th
Get a single Campaign User
Get a particular Campaign User object Parameter Accessible via URL https://api.channel.io/open/v5/mkt/campaigns/{campaignId}/campaign-users/{userId} and HTTP GET Parameter Example Required Description Parameter Type campaignId 1234 Required ID of Campaign object Path userId 5ec3a01fe2b3f4d2cbc5 Required ID of User object Path Example GET https://api.channel.io/open/v5/mkt/campaigns/1234/campaign-users/5ec3a01fe2b3f4d2cbc5 Response Returns a Campaign User object along with related information { "
List of OneTimeMsg
Retrieve a list of OneTimeMsg objects Parameter Accessible via URL https://api.channel.io/open/v5/mkt/one-time-msgs and HTTP GET Parameter Example Required Description Parameter Type since 1605795977290 Optional Epoch time in microseconds of the first OneTimeMsg to be retrieved. Pagination is supported along with the next value contained in the root object of the JSON response. Query limit 25 Optional Restrict the maximum number of OneTimeMsg objects to be retrieved - min : 1 - max : 500 - defau
Get a single OneTimeMsg
Get a particular OneTimeMsg object Parameter Accessible via URL https://api.channel.io/open/v5/mkt/one-time-msgs/{id} and HTTP GET Parameter Example Required Description Parameter Type id 1234 Required ID of OneTimeMsg object Path Example GET https://api.channel.io/open/v5/mkt/one-time-msgs/1234 Response Returns a OneTimeMsg object along with related information { "oneTimeMsg": { "id": "string", "channelId": "string", "name": "string", "state": "draft", "sendMedium": "appAlimtalk", "settings": {
List of OneTimeMsg Users
Retrieve a list of OneTimeMsg User objects Parameter Accessible via URL https://api.channel.io/open/v5/mkt/one-time-msgs/{id}/one-time-msg-users and HTTP GET Parameter Example Required Description Parameter Type id 1234 Required ID of OneTimeMsg object Path state sent Required The type of OneTimeMsg User objects to be retrieved. - available values : sent, view, goal, click Query since eyJjaGF0S2V5IjoiZ3Jvn0= Optional Encoded key of the first OneTimeMsg User to be retrieved. Pagination is support
Get a single OneTimeMsg User
Get a particular OneTimeMsg User object Parameter Accessible via URL https://api.channel.io/open/v5/mkt/one-time-msgs/{oneTimeMsgId}/one-time-msg-users/{userId} and HTTP GET Parameter Example Required Description Parameter Type oneTimeMsgId 1234 Required ID of OneTimeMsg object Path userId 5ec3a01fe2b3f4d2cbc5 Required ID of User object Path Example GET https://api.channel.io/open/v5/mkt/one-time-msgs/1234/one-time-msg-users/5ec3a01fe2b3f4d2cbc5 Response Returns a OneTimeMsg User object along wi