The statistics of the app banner
"},"metadata":{"type":"object","properties":{"query":{"type":"object","properties":{"startDate":{"type":"string"},"endDate":{"type":"string"}}}}}},"required":["statistics"]}}},"description":"Success-Response:"}}}},"/channel/{id}/events":{"post":{"tags":["Channel_Events"],"summary":"CreateChannelConversionEvents","description":"Create channel conversion events","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"The channel id","required":true}],"responses":{"201":{"content":{"application/json":{"example":"HTTP/1.1 201 Created\n{\n \"success\": true\n}","schema":{"title":"Success-Response:","type":"object","properties":{"success":{"type":"boolean"}}}}},"description":"Success-Response:"}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"channel":{"type":"string","description":"Channel Id
"},"name":{"type":"string","description":"Event name
"},"triggerType":{"type":"string","description":"Can be one of the following: custom (Event tracking code) path - Path RegEx selector - CSS Selector function - JavaScript function cpc - CPC (Cost per click)
"},"shared":{"type":"boolean","description":"Is shared between channels
"},"triggerPath":{"type":"string","description":"E.g. /examplePath
"},"triggerSelector":{"type":"string","description":"E.g. .className
"},"triggerFunction":{"type":"string","description":"E.g. "function(){}""
"},"amountFunction":{"type":"string","description":"E.g. "function(){}""
"},"currencies":{"items":{"type":"string","description":"E.g. [ "EUR" ]
"},"type":"array","description":"E.g. [ "EUR" ]
"},"enableCpcTracking":{"type":"boolean","description":"Enable CPC tracking
"},"properties":{"items":{"type":"string","description":"E.g. [ "examplePropertyName" ]
"},"type":"array","description":"E.g. [ "examplePropertyName" ]
"}},"type":"object","required":["channel","name","triggerType"]}}}}},"get":{"tags":["Channel_Events"],"summary":"GetChannelConversionEvents","description":"Get channel conversion events","parameters":[{"schema":{"type":"string"},"in":"header","name":"Authorization","description":"Private API key","required":true},{"schema":{"type":"string"},"in":"path","name":"id","description":"The channel id","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"events\": [\n {\n \"_id\": \"exampleId\",\n \"channel\": \"exampleId\",\n \"name\": \"Test\",\n \"shared\": false,\n \"triggerType\": \"path\",\n \"triggerPath\": \"/examplePath\",\n \"triggerSelector\": \"cssSelector\",\n \"triggerFunction\": \"function(){}\",\n \"amountFunction\": \"function(){}\",\n \"attributes\": [ ],\n \"currencies\": [ ],\n \"enableCpcTracking\": false,\n \"properties\": [ \"examplePropertyName\" ]\n }\n ]\n}","schema":{"title":"Success-Response:","type":"object","properties":{"events":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"channel":{"type":"string"},"name":{"type":"string"},"shared":{"type":"boolean"},"triggerType":{"type":"string"},"triggerPath":{"type":"string"},"triggerSelector":{"type":"string"},"triggerFunction":{"type":"string"},"amountFunction":{"type":"string"},"attributes":{"type":"array","items":{}},"currencies":{"type":"array","items":{}},"enableCpcTracking":{"type":"boolean"},"properties":{"type":"array","items":{"type":"string"}}}},"description":"List of conversion events
"}},"required":["events"]}}},"description":"Success-Response:"}}}},"/channel/{id}/segments":{"post":{"tags":["Channel_segments"],"summary":"CreateChannelSegment","description":"Create channel segment","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"The channel id","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"id\": \"XXXX\",\n \"success\": true\n}","schema":{"title":"Success-Response:","type":"object","properties":{"id":{"type":"string"},"success":{"type":"boolean","description":""}},"required":["success"]}}},"description":"Success-Response:"}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"name":{"type":"string","description":"Segment name
"},"filterOperator":{"type":"string","description":"Boolean operator for chaining the filters ('and' or 'or')
"},"filters":{"type":"array","items":{"type":"object","properties":{}},"description":"Array to create segments with filters included below
type:
Can be 'clickRate', 'tags', 'excludeTags', 'topics', 'excludeTopics', 'platform', 'excludePlatform', 'browser', 'excludeBrowser', 'language', 'country', 'daysSinceOptIn', 'notificationGroupClicked', 'notificationGroupDelivered'
value:
Depends on filter, can be integer, string or array
[relation] Optional:
Use 'gt' for greater than or 'lt' for lesser than
[days] Optional:
Days, e.g. 14 or 30
Object example:
{ "type": 'clickRate', "value": 1, "days": 7 }
channel ID
"},"name":{"type":"string","description":"segment's name
"},"subscriptions":{"type":"number","description":"segment's subscriptions count
"},"filters":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"filter's type
"},"operator":{"type":"string","description":"filter's operator value
"},"children":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"children types name
"},"relation":{"type":"string","description":"children relation name
"},"value":{"type":"array","items":{"type":"string"},"description":"array of children value ID
"}},"required":["type","relation","value"]},"description":"filter's children value
"}},"required":["type","operator","children"]},"description":"segment's filter array object
"},"shared":{"type":"boolean","description":"shared boolean value
"},"filterOperator":{"type":"string","description":"filterOperator value
"},"createdAt":{"type":"string","description":"date of create of segments
"},"updatedAt":{"type":"string","description":"date of update of segments
"},"updateJobNecessary":{"type":"boolean","description":"boolean value
"},"channelInactiveSubscriptions":{"type":"object","properties":{"XXXXXXXXXXX":{"type":"number"}},"description":"object of channel ID with number value
"},"channelSubscriptions":{"type":"object","properties":{"XXXXXXXXXXX":{"type":"number"}},"description":"object of channel ID with number value
"},"inactiveSubscriptions":{"type":"number","description":"inactiveSubscriptions count
"},"id":{"type":"string","description":"channel segments ID
"}},"required":["id","channel","name","subscriptions","filters","shared","filterOperator","updatedAt","createdAt","updateJobNecessary","channelInactiveSubscriptions","channelSubscriptions","inactiveSubscriptions"]},"description":"Array of data on the channel segments
"}},"required":["segments"]}}},"description":"Success-Response:"}}}},"/channel/{id}/segment/{segmentId}":{"get":{"tags":["Channel_segments"],"summary":"GetChannelSegment","description":"Get channel segment","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"The channel id","required":true},{"schema":{"type":"string"},"in":"path","name":"segmentId","description":"The segment id","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"segment\": {\n \"_id\": \"XXXXXXXXXXXXXXX\",\n \"filters\": []\n }\n}","schema":{"title":"Success-Response:","type":"object","properties":{"segment":{"type":"object","properties":{"_id":{"type":"string"},"filters":{"type":"array","items":{}}},"description":"Requested segment
"}},"required":["segment"]}}},"description":"Success-Response:"}}},"post":{"tags":["Channel_segments"],"summary":"UpdateChannelSegment","description":"Update channel segment","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"The channel id","required":true},{"schema":{"type":"string"},"in":"path","name":"segmentId","description":"The segment id","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"success\": true\n}","schema":{"title":"Success-Response:","type":"object","properties":{"success":{"type":"boolean","description":"Status of the update
"}},"required":["success"]}}},"description":"Success-Response:"}},"requestBody":{"content":{"application/json":{"schema":{"properties":{},"type":"object"}}}}}},"/channel/{id}/segment/{segmentId}/statistics":{"get":{"tags":["Channel_segments"],"summary":"GetChannelSegmentStatistics","description":"Get channel segment statistics","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"The channel id","required":true},{"schema":{"type":"string"},"in":"path","name":"segmentId","description":"The segment id","required":true},{"schema":{"type":"string"},"in":"query","name":"startDate","description":"A number representing the amount of seconds passed since January 1, 1970, 00:00:00 UTC, until start date is reached."},{"schema":{"type":"string"},"in":"query","name":"endDate","description":"A number representing the amount of seconds passed since January 1, 1970, 00:00:00 UTC, until end date is reached."}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"statistics\": [\n {\n \"_id\": \"XXXXXXXXXXXXXXX\",\n \"date\": \"2021-06-24T00:00:00.000+0000\",\n \"inactiveSubscriptions\": 0,\n \"subscriptions\": 0,\n \"inactiveSubscriptions\": 0\n }\n ]\n}","schema":{"title":"Success-Response:","type":"object","properties":{"statistics":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"date":{"type":"string","description":"date of creation
"},"inactiveSubscriptions":{"type":"number","description":"inactiveSubscriptions count
"},"subscriptions":{"type":"number","description":"subscriptions count
"},"id":{"type":"string","description":"statistics ID
"}},"required":["id","date","inactiveSubscriptions","subscriptions"]},"description":"Data with statistics for specified channel's segment
"}},"required":["statistics"]}}},"description":"Success-Response:"}}}},"/tag/create":{"post":{"tags":["Channel_tags"],"summary":"CreateTag","description":"Create channel tag","parameters":[],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"tagId\": \"XXXXXXXXXXXXXXXXX\"\n}","schema":{"title":"Success-Response:","type":"object","properties":{"tagId":{"type":"string"},"success":{"type":"boolean","description":""}},"required":["success"]}}},"description":"Success-Response:"}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"channelId":{"type":"string","description":"The channel ID (can be a string or array of strings).
"},"name":{"type":"string","description":"The tag name.
"},"externalId":{"type":"string","description":"The external tag ID. Must be unique per channel.
"},"autoAssignPath":{"type":"string","description":"The auto assign URL path.
"},"autoAssignFunction":{"type":"string","description":"The auto assign JS function.
"},"autoAssignSeconds":{"type":"number","description":"The auto assign min. seconds.
"},"autoAssignVisits":{"type":"number","description":"The auto assign min. visits.
"},"autoAssignSessions":{"type":"number","description":"The auto assign min. sessions.
"}},"type":"object","required":["channelId","name"]}}}}}},"/channel/{id}/tag/{tagId}":{"delete":{"tags":["Channel_tags"],"summary":"DeleteChannelTag","description":"Delete channel tag","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"Channel ID","required":true},{"schema":{"type":"string"},"in":"path","name":"tagId","description":"Tag ID","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"success\": true\n}","schema":{"title":"Success-Response:","type":"object","properties":{"success":{"type":"boolean","description":""}},"required":["success"]}}},"description":"Success-Response:"}}},"get":{"tags":["Channel_tags"],"summary":"GetChannelTag","description":"Get channel tag","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"Channel ID","required":true},{"schema":{"type":"string"},"in":"path","name":"tagId","description":"Tag ID","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"tag\": {\n \"_id\": \"xxxxxxxxxxxxxxxxx\",\n \"channel\": \"xxxxxxxxxxxxxxxxx\",\n \"name\": \"Example Tag\",\n \"subscriptions\": 0\n }\n}","schema":{"title":"Success-Response:","type":"object","properties":{"tag":{"type":"object","properties":{"_id":{"type":"string"},"channel":{"type":"string"},"name":{"type":"string"},"subscriptions":{"type":"number"}},"description":"Data of single channel tag
"}},"required":["tag"]}}},"description":"Success-Response:"}}},"post":{"tags":["Channel_tags"],"summary":"UpdateChannelTag","description":"Update channel tag","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"Channel ID","required":true},{"schema":{"type":"string"},"in":"path","name":"tagId","description":"Tag ID","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"success\": true\n}","schema":{"title":"Success-Response:","type":"object","properties":{"success":{"type":"boolean","description":""}},"required":["success"]}}},"description":"Success-Response:"}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"name":{"type":"string","description":"The tag name.
"},"externalId":{"type":"string","description":"The external tag ID.
"},"sort":{"type":"number","description":"Sort value.
"},"autoAssignPath":{"type":"string","description":"The auto assign URL path.
"},"autoAssignOptInPath":{"type":"string","description":"The auto assign opt-in URL path.
"},"autoAssignFunction":{"type":"string","description":"The auto assign JS function.
"},"autoAssignSelector":{"type":"string","description":"The auto assign CSS selector.
"},"autoAssignSeconds":{"type":"number","description":"The auto assign min. seconds.
"},"autoAssignVisits":{"type":"number","description":"The auto assign min. visits.
"},"autoAssignSessions":{"type":"number","description":"The auto assign min. sessions.
"},"autoAssignSessionVisits":{"type":"boolean","description":"Enables session visit based auto assignment.
"},"autoAssignDays":{"type":"number","description":"The auto assign min. days.
"},"autoAssignCheckInterval":{"type":"number","description":"The auto assign check interval.
"},"icon":{"type":"string","description":"The tag icon.
"},"defaultNotificationIconUrl":{"type":"string","description":"The default notification icon URL.
"},"includeAllSubscriptions":{"type":"boolean","description":"Includes all subscriptions.
"}},"type":"object"}}}}}},"/channel/{id}/tag/externalId/{externalId}":{"get":{"tags":["Channel_tags"],"summary":"GetChannelTagByExternalId","description":"Get channel tag by externalId","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"Channel ID","required":true},{"schema":{"type":"string"},"in":"path","name":"externalId","description":"The external tag ID","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"tags\": [\n {\n \"_id\": \"xxxxxxxxxxxxxxxxx\",\n \"channel\": \"xxxxxxxxxxxxxxxxx\",\n \"name\": \"Example Tag\",\n \"externalId\": \"my-external-id\",\n \"subscriptions\": 0\n }\n ]\n}","schema":{"title":"Success-Response:","type":"object","properties":{"tags":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"channel":{"type":"string"},"name":{"type":"string"},"externalId":{"type":"string"},"subscriptions":{"type":"number"}}},"description":"Array of matching channel tags
"}},"required":["tags"]}}},"description":"Success-Response:"}}}},"/channel/{id}/tag-groups":{"get":{"tags":["Channel_tags"],"summary":"GetChannelTagGroups","description":"Get channel tag groups","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"The channel id","required":true},{"schema":{"type":"string"},"in":"query","name":"limit","description":"Used for pagination. Default: 50, Max: 100"},{"schema":{"type":"string"},"in":"query","name":"skip","description":"Used for pagination. Default: 0"}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"tagGroups\": [{\n \"_id\": \"XXXXXXXXXXXX\",\n \"channel\": \"XXXXXXXXXXX\",\n \"name\": \"tag group name\",\n \"createdAt\": \"2021-11-10T14:27:04.267Z\",\n \"tags\": [\"XXXXXXXXXXXX\", \"XXXXXXXXXXXX\"]\n }]\n}","schema":{"title":"Success-Response:","type":"object","properties":{"tagGroups":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string","description":"tag group ID
"},"channel":{"type":"string","description":"tag group of channel ID
"},"name":{"type":"string","description":"tag group name
"},"createdAt":{"type":"string","description":"date of creation
"},"tags":{"type":"array","items":{"type":"string"},"description":"Array of tag IDs
"}},"required":["_id","channel","name","tags","createdAt"]},"description":"Data of all tag groups connected to specified channel
"}},"required":["tagGroups"]}}},"description":"Success-Response:"}}}},"/channel/{id}/tag/{tagId}/statistics":{"get":{"tags":["Channel_tags"],"summary":"GetChannelTagStatistics","description":"Get channel tag statistics","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"The channel id","required":true},{"schema":{"type":"string"},"in":"path","name":"tagId","description":"The tag id","required":true},{"schema":{"type":"string"},"in":"query","name":"startDate","description":"A number representing the amount of seconds passed since January 1, 1970, 00:00:00 UTC, until start date is reached."},{"schema":{"type":"string"},"in":"query","name":"endDate","description":"A number representing the amount of seconds passed since January 1, 1970, 00:00:00 UTC, until end date is reached."}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"statistics\": [\n {\n \"_id\": \"XXXXXXXXXXXXXXX\",\n \"date\": \"2021-06-24T00:00:00.000+0000\",\n \"subscriptions\": 10,\n \"inactiveSubscriptions\": 0\n }\n ]\n}","schema":{"title":"Success-Response:","type":"object","properties":{"statistics":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"date":{"type":"string","description":"date of creation
"},"subscriptions":{"type":"number","description":"subscriptions count
"},"inactiveSubscriptions":{"type":"number","description":"inactive subscriptions count
"},"id":{"type":"string","description":"statistics ID
"}},"required":["id","date","subscriptions","inactiveSubscriptions"]},"description":"Array of Data specific statistics for given tag
"}},"required":["statistics"]}}},"description":"Success-Response:"}}}},"/channel/{id}/tags":{"get":{"tags":["Channel_tags"],"summary":"GetChannelTags","description":"Get channel tags","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"The channel id","required":true},{"schema":{"type":"string"},"in":"query","name":"limit","description":"Used for pagination. Default: 50, Max: 100"},{"schema":{"type":"string"},"in":"query","name":"skip","description":"Used for pagination. Default: 0"},{"schema":{"type":"string"},"in":"query","name":"tagGroupId","description":"Used for tag group based filtering."}],"responses":{"200":{"content":{"application/json":{"example":" HTTP/1.1 200 OK\n {\n \"tags\": [{\n \"subscriptions\": 0,\n \"_id\": \"XXXXXXXXXXXX\",\n \"channel\": [\"XXXXXXXXXXX\"],\n \"name\": \"tag name\",\n \"autoAssignSeconds\": \"\",\n \"autoAssignVisits\": \"\",\n \"autoAssignFunction\": \"\",\n \"autoAssignPath\": \"\",\n \"sort\": 2,\n \"createdAt\": \"2021-11-10T14:27:04.267Z\",\n \"channelInactiveSubscriptions\": {\n \"XXXXXXXXXXXX\": 0\n },\n \"channelSubscriptions\": {\n \"XXXXXXXXXXXX\": 0\n },\n \"inactiveSubscriptions\": 0,\n \"tagGroups\": [{\n \"_id\": \"XXXXXXXXXXXX\",\n \"channel\": \"XXXXXXXXXXX\",\n \"name\": \"tag group name\",\n \"createdAt\": \"2021-11-10T14:27:04.267Z\",\n \"tags\": [\"XXXXXXXXXXXX\", \"XXXXXXXXXXXX\"]\n}]\n }]\n }","schema":{"title":"Success-Response:","type":"object","properties":{"tags":{"type":"array","items":{"type":"object","properties":{"subscriptions":{"type":"number","description":"subscriptions count
"},"_id":{"type":"string"},"channel":{"type":"array","items":{"type":"string"},"description":"array of channel ID
"},"name":{"type":"string","description":"tag name
"},"autoAssignSeconds":{"type":"string","description":"autoAssignSeconds of tag
"},"autoAssignVisits":{"type":"string","description":"autoAssignVisits of tag
"},"autoAssignFunction":{"type":"string","description":"autoAssignFunction of tag
"},"autoAssignPath":{"type":"string","description":"autoAssignPath of tag
"},"sort":{"type":"number","description":"sort value
"},"createdAt":{"type":"string","description":"date of creation
"},"channelInactiveSubscriptions":{"type":"object","properties":{"XXXXXXXXXXXX":{"type":"number"}},"description":"channelInactiveSubscriptions with channel ID and count
"},"channelSubscriptions":{"type":"object","properties":{"XXXXXXXXXXXX":{"type":"number"}},"description":"channelSubscriptions with channel ID and count
"},"inactiveSubscriptions":{"type":"number","description":"inactiveSubscriptions count
"},"tagGroups":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string","description":"tag group ID
"},"channel":{"type":"string","description":"tag group of channel ID
"},"name":{"type":"string","description":"tag group name
"},"createdAt":{"type":"string","description":"date of creation
"},"tags":{"type":"array","items":{"type":"string"},"description":"Array of tag IDs
"}},"required":["_id","channel","name","tags","createdAt"]},"description":"Data of all tag groups connected to specified channel
"},"id":{"type":"string","description":"tags ID
"}},"required":["subscriptions","id","channel","name","autoAssignSeconds","autoAssignVisits","autoAssignFunction","autoAssignPath","sort","createdAt","channelInactiveSubscriptions","channelSubscriptions","inactiveSubscriptions","tagGroups"]},"description":"Data of all tags connected to specified channel
"}},"required":["tags"]}}},"description":"Success-Response:"}}}},"/subscription/tags/sync":{"post":{"tags":["Channel_tags"],"summary":"SyncSubscriptionTags","description":"Sync Subscription Tags","parameters":[],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"success\": true,\n \"results\": [\n {\n \"externalId\": \"tag-001\",\n \"name\": \"Tag 1\",\n \"status\": \"created\"\n },\n {\n \"externalId\": \"tag-002\",\n \"name\": \"Tag 2\",\n \"status\": \"exists\"\n }\n ]\n}","schema":{"title":"Success Response:","type":"object","properties":{"success":{"type":"boolean"},"results":{"type":"array","items":{"type":"object","properties":{"externalId":{"type":"string"},"name":{"type":"string"},"status":{"type":"string"}},"required":["externalId","name","status"]}},"externalId":{"type":"string","description":"The external identifier of the processed tag.
"},"name":{"type":"string","description":"The name of the processed tag.
"},"status":{"type":"string","description":"Indicates whether the tag was created ("created") or already existed ("exists").
"}},"required":["externalId","name","status"]}}},"description":"Success Response:"},"400":{"content":{"application/json":{"example":"HTTP/1.1 400 Bad Request\n{\n \"success\": false,\n \"error\": \"Invalid or empty tags array.\"\n}","schema":{"title":"Error Response:","type":"object","properties":{"success":{"type":"boolean"},"error":{"type":"string"}}}}},"description":"Error Response:"}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"channelId":{"type":"string","description":"The unique identifier for the channel.
"},"subscriptionId":{"type":"string","description":"The subscriptionId used to update the subscription's tags. (Either subscriptionId or customAttributes.user_id is required)
"},"tags":{"type":"array","items":{"type":"object","properties":{"externalId":{"type":"string","description":"The unique external identifier for the tag.
"},"name":{"type":"string","description":"The name of the tag.
"}},"required":["externalId","name"]},"description":"An array of tag objects, each containing:
"}},"type":"object","required":["channelId","subscriptionId","tags"]}}}}}},"/channel/{id}/topics":{"post":{"tags":["Channel_topics"],"summary":"CreateChannelTopic","description":"Create channel topic","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"The channel id","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"topicId\": \"XXXXXXXXXXXXXXXXX\"\n}","schema":{"title":"Success-Response:","type":"object","properties":{"topicId":{"type":"string"},"success":{"type":"boolean","description":""}},"required":["success"]}}},"description":"Success-Response:"}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"name":{"type":"string","description":"The topic name.
"},"externalId":{"type":"string","description":"The topic external ID.
"},"customData":{"type":"object","properties":{},"description":"The topic custom data.
"}},"type":"object","required":["name"]}}}}},"get":{"tags":["Channel_topics"],"summary":"GetChannelTopics","description":"Get channel topics","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"The channel id","required":true},{"schema":{"type":"string"},"in":"query","name":"limit","description":"Used for pagination. Default: 50, Max: 100"},{"schema":{"type":"string"},"in":"query","name":"skip","description":"Used for pagination. Default: 0"},{"schema":{"type":"string"},"in":"query","name":"includeHidden","description":"Set to true to include hidden topics"}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"topics\": [\n {\n \"_id\": \"xxxxxxxxxxxxxxxxx\",\n \"channel\": [\"xxxxxxxxxxxxxxxxx\"],\n \"createdAt\": \"2018-01-01T01:00:00.000Z\",\n \"name\": \"Example Topic\",\n \"shared\": true,\n \"subscriptions\": 0,\n \"parentTopic\": \"XXXXXXXXXX\"\n }\n ]\n}","schema":{"title":"Success-Response:","type":"object","properties":{"topics":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"channel":{"type":"array","items":{"type":"string"},"description":"array of channel ID
"},"createdAt":{"type":"string","description":"date of creation
"},"name":{"type":"string","description":"name of topics
"},"shared":{"type":"boolean","description":"topics shared
"},"subscriptions":{"type":"number","description":"subscriptions count
"},"parentTopic":{"type":"string","description":"parentTopic ID
"},"id":{"type":"string","description":"topics ID
"},"layerFunction":{"type":"string","description":"layerFunction of topics
"}},"required":["id","channel","createdAt","name","layerFunction","shared","subscriptions","parentTopic"]},"description":"Array of topics connected to specified channel
"}},"required":["topics"]}}},"description":"Success-Response:"}}}},"/channel/{id}/topic/{topicId}/statistics":{"get":{"tags":["Channel_topics"],"summary":"GetChannelTopicStatistics","description":"Get channel topic statistics","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"The channel id","required":true},{"schema":{"type":"string"},"in":"path","name":"topicId","description":"The topic id","required":true},{"schema":{"type":"string"},"in":"query","name":"startDate","description":"A number representing the amount of seconds passed since January 1, 1970, 00:00:00 UTC, until start date is reached."},{"schema":{"type":"string"},"in":"query","name":"endDate","description":"A number representing the amount of seconds passed since January 1, 1970, 00:00:00 UTC, until end date is reached."}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"statistics\": [\n {\n \"_id\": \"XXXXXXXXXXXXXXX\",\n \"date\": \"2021-06-24T00:00:00.000+0000\",\n \"subscriptions\": 10,\n \"inactiveSubscriptions\": 0\n }\n ]\n}","schema":{"title":"Success-Response:","type":"object","properties":{"statistics":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"date":{"type":"string","description":"date of creation
"},"subscriptions":{"type":"number","description":"subscriptions count,
"},"inactiveSubscriptions":{"type":"number","description":"inactive subscriptions count
"},"id":{"type":"string","description":"statistics ID
"}},"required":["id","date","subscriptions","inactiveSubscriptions"]},"description":"Array of specified topic statistics connected to specified channel
"}},"required":["statistics"]}}},"description":"Success-Response:"}}}},"/channels":{"post":{"tags":["Channels"],"summary":"CreateChannel","description":"Create channel","parameters":[],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"id\": \"xxxxxxxxxxxxxxx\"\n}","schema":{"title":"Success-Response:","type":"object","properties":{"id":{"type":"string","description":""}},"required":["id"]}}},"description":"Success-Response:"}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"name":{"type":"string","description":"See the "Get channel" route for parameters.
"}},"type":"object","required":["name"]}}}}},"get":{"tags":["Channels"],"summary":"GetChannels","description":"Get channels","parameters":[],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"channels\": [\n {\n \"_id\": \"xxxxxxxxxxxxxxxxx\",\n \"user\": \"xxxxxxxxxxxxxxxxx\",\n \"name\": \"Example Channel\",\n \"identifier\": \"example\",\n \"example\": \"example.com\",\n \"iconUrl\": \"https://static.cleverpush.com/channel/icon/2676037e-920a-4b2c-9e1f-e93e814c30ea.png\",\n \"iconFile\": \"2676037e-920a-4b2c-9e1f-e93e814c30ea.png\",\n \"subscriptions\": 0,\n \"optIns\": 0,\n \"confirmAlerts\": 4,\n \"confirmAlertBackdrop\": true,\n \"showNotificationBell\": false,\n \"autoRegister\": false,\n \"createdAt\": \"2018-01-01T12:00:00.000Z\",\n \"vapidPublicKey\": \"XXX\",\n \"vapidPrivateKey\": \"XXX\",\n \"confirmAlertTheme\": \"\",\n \"confirmAlertThemeBackground\": \"\",\n \"confirmAlertThemeVariant\": \"\",\n \"confirmAlertNativeTheme\": \"\",\n \"alertMinimumVisits\": 0,\n \"ownDomain\": false,\n \"showConfirmAlert\": true,\n \"hideBranding\": true,\n \"hideFaqLink\": true,\n \"alertTimeout\": 1,\n \"alertLocalization\": {\n \"title\": \"Receive push notifications\",\n \"info\": \"You can unsubscribe at any time\",\n \"allow\": \"Allow\",\n \"deny\": \"Deny\"\n }\n }\n ]\n}","schema":{"title":"Success-Response:","type":"object","properties":{"channels":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"user":{"type":"string"},"name":{"type":"string"},"identifier":{"type":"string"},"example":{"type":"string"},"iconUrl":{"type":"string"},"iconFile":{"type":"string"},"subscriptions":{"type":"number"},"optIns":{"type":"number"},"confirmAlerts":{"type":"number"},"confirmAlertBackdrop":{"type":"boolean"},"showNotificationBell":{"type":"boolean"},"autoRegister":{"type":"boolean"},"createdAt":{"type":"string"},"vapidPublicKey":{"type":"string"},"vapidPrivateKey":{"type":"string"},"confirmAlertTheme":{"type":"string"},"confirmAlertThemeBackground":{"type":"string"},"confirmAlertThemeVariant":{"type":"string"},"confirmAlertNativeTheme":{"type":"string"},"alertMinimumVisits":{"type":"number"},"ownDomain":{"type":"boolean"},"showConfirmAlert":{"type":"boolean"},"hideBranding":{"type":"boolean"},"hideFaqLink":{"type":"boolean"},"alertTimeout":{"type":"number"},"alertLocalization":{"type":"object","properties":{"title":{"type":"string"},"info":{"type":"string"},"allow":{"type":"string"},"deny":{"type":"string"}}}}},"description":"Array of Objects with channel data
"}},"required":["channels"]}}},"description":"Success-Response:"}}}},"/channel/{id}":{"get":{"tags":["Channels"],"summary":"GetChannel","description":"Get channel","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"The channel id","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"channel\": {\n \"_id\": \"xxxxxxxxxxxxxxxxx\",\n \"user\": \"xxxxxxxxxxxxxxxxx\",\n \"name\": \"Example Channel\",\n \"identifier\": \"example\",\n \"iconUrl\": \"https://static.cleverpush.com/channel/icon/2676037e-920a-4b2c-9e1f-e93e814c30ea.png\",\n \"iconFile\": \"2676037e-920a-4b2c-9e1f-e93e814c30ea.png\",\n \"project\": \"XXXXXXXXXXXX\",\n \"subscriptions\": 0,\n \"inactive\": false,\n \"type\": \"web\",\n \"domain\": \"domain name\",\n \"optIns\": 0,\n \"confirmAlerts\": 4,\n \"confirmAlertBackdrop\": true,\n \"showNotificationBell\": false,\n \"autoRegister\": false,\n \"createdAt\": \"2018-01-01T12:00:00.000Z\",\n \"confirmAlertTheme\": \"\",\n \"confirmAlertThemeBackground\": \"\",\n \"confirmAlertThemeVariant\": \"\",\n \"confirmAlertNativeTheme\": \"\",\n \"alertMinimumVisits\": 0,\n \"ownDomain\": false,\n \"showConfirmAlert\": true,\n \"hideBranding\": true,\n \"hideFaqLink\": true,\n \"alertTimeout\": 1,\n \"alertLocalization\": {\n \"title\": \"Receive push notifications\",\n \"info\": \"You can unsubscribe at any time\",\n \"allow\": \"Allow\",\n \"deny\": \"Deny\"\n }\n }\n}","schema":{"title":"Success-Response:","type":"object","properties":{"channel":{"type":"object","properties":{"_id":{"type":"string","description":"channel ID
"},"user":{"type":"string","description":"user ID
"},"name":{"type":"string","description":"Channel's name
"},"identifier":{"type":"string","description":"identifier
"},"iconUrl":{"type":"string","description":"url of icon image.
"},"iconFile":{"type":"string","description":"icon file name
"},"project":{"type":"string","description":"project ID
"},"subscriptions":{"type":"number","description":"subscriptions count
"},"inactive":{"type":"boolean","description":"inactive boolean value
"},"type":{"type":"string","description":"type type of channel
"},"domain":{"type":"string","description":"domain domain name of channel
"},"optIns":{"type":"number","description":"optIns count
"},"confirmAlerts":{"type":"number","description":"confirmAlerts count
"},"confirmAlertBackdrop":{"type":"boolean","description":"boolean value either true or false
"},"showNotificationBell":{"type":"boolean","description":"boolean value either true or false
"},"autoRegister":{"type":"boolean","description":"boolean value either true or false
"},"createdAt":{"type":"string","description":"Date in UTC String format
"},"confirmAlertTheme":{"type":"string","description":"string value
"},"confirmAlertThemeBackground":{"type":"string","description":"string value
"},"confirmAlertThemeVariant":{"type":"string","description":"string value
"},"confirmAlertNativeTheme":{"type":"string","description":"string value
"},"alertMinimumVisits":{"type":"number","description":"alertMinimumVisits count
"},"ownDomain":{"type":"boolean","description":"boolean value either true or false
"},"showConfirmAlert":{"type":"boolean","description":"boolean value either true or false
"},"hideBranding":{"type":"boolean","description":"boolean value either true or false
"},"hideFaqLink":{"type":"boolean","description":"boolean value either true or false
"},"alertTimeout":{"type":"number","description":"alertTimeout count
"},"alertLocalization":{"type":"object","properties":{"title":{"type":"string","description":"title of alert
"},"info":{"type":"string","description":"short description of alert
"},"allow":{"type":"string","description":"text
"},"deny":{"type":"string","description":"text
"}},"description":"Object with alertLocalization data
","required":["title","info","allow","deny"]},"welcomeNotification":{"type":"object","properties":{},"description":"Object with targetted channel data
"}},"description":"Object with targetted channel data
","required":["_id","user","name","identifier","iconUrl","iconFile","project","subscriptions","inactive","type","domain","optIns","confirmAlerts","confirmAlertBackdrop","showNotificationBell","autoRegister","createdAt","confirmAlertTheme","confirmAlertThemeBackground","confirmAlertThemeVariant","confirmAlertNativeTheme","alertMinimumVisits","ownDomain","showConfirmAlert","hideBranding","hideFaqLink","welcomeNotification","alertTimeout","alertLocalization"]}},"required":["channel"]}}},"description":"Success-Response:"}}},"post":{"tags":["Channels"],"summary":"UpdateChannel","description":"Update channel","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"The channel id","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"success\": true\n}","schema":{"title":"Success-Response:","type":"object","properties":{"success":{"type":"boolean","description":""}},"required":["success"]}}},"description":"Success-Response:"}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"name":{"type":"string","description":"See the "Get channel" route for parameters to update.
"},"whatsappWelcomeMessage":{"type":"object","properties":{},"description":"The WhatsApp welcome message will be sent as soon as someone activates your bot. See the example above for the object structure, it uses the messengerMessage
"},"whatsappCommands":{"type":"array","items":{"type":"object","properties":{}},"description":"Array of commands that the bot reacts to messengerCommand
"},"whatsappDefaultMessage":{"type":"object","properties":{},"description":"This is the default response your bot will send if it can not assign the received message to a command.
"},"facebookWelcomeMessage":{"type":"object","properties":{},"description":"The same as whatsappWelcomeMessage
"},"facebookCommands":{"type":"array","items":{"type":"object","properties":{}},"description":"The same as whatsappCommands
"},"facebookDefaultMessage":{"type":"object","properties":{},"description":"The same as whatsappDefaultMessage
"},"telegramWelcomeMessage":{"type":"object","properties":{},"description":"The same as whatsappWelcomeMessage
"},"telegramCommands":{"type":"array","items":{"type":"object","properties":{}},"description":"The same as whatsappCommands
"},"telegramDefaultMessage":{"type":"object","properties":{},"description":"The same as whatsappDefaultMessage
"},"lineWelcomeMessage":{"type":"object","properties":{},"description":"The same as whatsappWelcomeMessage
"},"lineCommands":{"type":"array","items":{"type":"object","properties":{}},"description":"The same as whatsappCommands
"},"lineDefaultMessage":{"type":"object","properties":{},"description":"The same as whatsappDefaultMessage
"}},"type":"object","required":["name"]}}}}}},"/channel/{id}/attribute-statistics":{"get":{"tags":["Channels"],"summary":"GetChannelAttributeStatistics","description":"Get channel attribute statistics","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"Channel ID","required":true},{"schema":{"type":"string"},"in":"query","name":"attribute","description":"Attribute ID","required":true},{"schema":{"type":"string"},"in":"query","name":"date","description":"Date in YYYY-MM-DD format. Will use current date if not provided."}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"_id\" : \"XXXXXXX\",\n \"date\" : \"2023-08-19T00:00:00.000+0000\",\n \"channel\" : \"XXXXXXX\",\n \"attribute\" : \"sub_id\",\n \"subscriptionCounts\" : {\n \"1\": 10,\n \"2\": 2\n }\n }","schema":{"title":"Success-Response:","type":"object","properties":{"_id":{"type":"string"},"date":{"type":"string"},"channel":{"type":"string"},"attribute":{"type":"string"},"subscriptionCounts":{"type":"object","properties":{"1":{"type":"number"},"2":{"type":"number"}}},"statistics":{"type":"object","properties":{},"description":"Object containing channel attribute statistics
"}},"required":["statistics"]}}},"description":"Success-Response:"}}}},"/channel/{id}/app-banner/{bannerId}":{"get":{"tags":["Channels"],"summary":"GetChannelInAppBanner","description":"Get in-app banner","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"The channel id","required":true},{"schema":{"type":"string"},"in":"path","name":"bannerId","description":"The app-banner id","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"_id\": \"xxxxxxxxxxx\",\n \"name\": \"xxxxxxxxxx\",\n \"status\": \"draft\",\n \"showOnlySubscribers\": true,\n \"frequency\": \"once\",\n \"startsAt\": \"..\",\n \"endsAt\": \"..\"\n}","schema":{"title":"Success-Response:","type":"object","properties":{"_id":{"type":"string"},"name":{"type":"string"},"status":{"type":"string"},"showOnlySubscribers":{"type":"boolean"},"frequency":{"type":"string"},"startsAt":{"type":"string"},"endsAt":{"type":"string"},"banner":{"type":"object","properties":{},"description":"Object with data for an in-app banner
"}},"required":["banner"]}}},"description":"Success-Response:"}}},"post":{"tags":["Channels"],"summary":"UpdateChannelInAppBanner","description":"Update in-app banner","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"The channel id","required":true},{"schema":{"type":"string"},"in":"path","name":"bannerId","description":"The app-banner id","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"success\": true\n}","schema":{"title":"Success-Response:","type":"object","properties":{"success":{"type":"boolean","description":""}},"required":["success"]}}},"description":"Success-Response:"}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"name":{"type":"string","description":""},"content":{"type":"string","description":"The banner's content (in HTML)
"},"frequency":{"type":"string","description":"Can be: once, once_per_session
"},"showOnlySubscribers":{"type":"boolean","description":""},"startsAt":{"type":"string","description":""},"endsAt":{"type":"string","description":""}},"type":"object","required":["name","content","frequency"]}}}}}},"/channel/{id}/app-banners":{"get":{"tags":["Channels"],"summary":"GetChannelInAppBanners","description":"Get in-app banners","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"Channel ID","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"banners\": [\n {\n \"_id\": \"xxxxxxxxxxx\",\n \"name\": \"xxxxxxxxxx\",\n \"status\": \"draft\",\n \"showOnlySubscribers\": true,\n \"frequency\": \"once\",\n \"startsAt\": \"..\",\n \"endsAt\": \"..\"\n }\n ]\n}","schema":{"title":"Success-Response:","type":"object","properties":{"banners":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"name":{"type":"string"},"status":{"type":"string"},"showOnlySubscribers":{"type":"boolean"},"frequency":{"type":"string"},"startsAt":{"type":"string"},"endsAt":{"type":"string"}}},"description":"Array of banners connected to the specified channel
"}},"required":["banners"]}}},"description":"Success-Response:"}}}},"/channel/{id}/statistics":{"get":{"tags":["Channels"],"summary":"GetChannelStatistics","description":"Get channel statistics","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"Channel ID","required":true},{"schema":{"type":"string"},"in":"query","name":"startDate","description":"Start date timestamp","required":true},{"schema":{"type":"string"},"in":"query","name":"endDate","description":"End date timestamp","required":true},{"schema":{"type":"string"},"in":"query","name":"aggregate","description":"Aggregate statistics? Defaults to true. Will output array if false."}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"sent\": 100,\n \"delivered\": 80,\n \"clicked\": 20,\n \"optIns\": 30,\n \"optOuts\": 20,\n \"confirmAlerts\": 60,\n \"subscriptionsEndDate\": 25,\n \"activeSubscriptionsEndDate\": 250,\n \"inactiveSubscriptionsEndDate\": 25\n}","schema":{"title":"Success-Response:","type":"object","properties":{"sent":{"type":"number","description":"total sent count in channel
"},"delivered":{"type":"number","description":"total delivered count in channel
"},"clicked":{"type":"number","description":"total clicked count in channel
"},"optIns":{"type":"number","description":"total optIns count in channel
"},"optOuts":{"type":"number","description":"total optOuts count in channel
"},"confirmAlerts":{"type":"number","description":"total confirmAlerts count in channel
"},"subscriptionsEndDate":{"type":"number","description":"total subscriptionsEndDate count in channel
"},"activeSubscriptionsEndDate":{"type":"number","description":"total activeSubscriptionsEndDate count in channel
"},"inactiveSubscriptionsEndDate":{"type":"number","description":"total inactiveSubscriptionsEndDate count in channel
"}},"required":["sent","delivered","clicked","optIns","optOuts","confirmAlerts","subscriptionsEndDate","activeSubscriptionsEndDate","inactiveSubscriptionsEndDate"]}}},"description":"Success-Response:"}}}},"/channel/{id}/subscription-count":{"get":{"tags":["Channels"],"summary":"GetChannelSubscriptionCount","description":"Get subscription count","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"The channel id","required":true},{"schema":{"type":"array","items":{"type":"string"}},"in":"query","name":"filters","description":"Array of filter objects containing multiple fields with relations (e.g.: [{ field: 'customAttributes.userId', value: 123, relation: 'eq' }, { field: 'customAttributes.age', value: 18, relation: 'gt' }]). Available relations: eq: equals, ne: not equals, gt: greater than, gte: greater than or equals, lt: lesser than, lte: lesser than or equals. Can't be used together with 'customAttributes' parameter."},{"schema":{"type":"array","items":{"type":"string"}},"in":"query","name":"tags","description":"Targeting: array of tag IDs."},{"schema":{"type":"string"},"in":"query","name":"tagsLogic","description":"One of: 'and', 'or', default: 'or'"},{"schema":{"type":"array","items":{"type":"string"}},"in":"query","name":"topics","description":"Targeting: array of topic IDs. Include null to match subscriptions without any topics."},{"schema":{"type":"string"},"in":"query","name":"topicsLogic","description":"One of: 'and', 'or', default: 'or'"},{"schema":{"type":"array","items":{"type":"string"}},"in":"query","name":"platform","description":"Targeting: array of platform names (case-sensitive, e.g. "Android", "Mac OS", ..)."},{"schema":{"type":"array","items":{"type":"string"}},"in":"query","name":"browser","description":"Targeting: array of browser names (case-sensitive, e.g. "Chrome", "Firefox", ..)."},{"schema":{"type":"array","items":{"type":"string"}},"in":"query","name":"country","description":"Targeting: array of country IDs (e.g. "US", "DE", ..)."},{"schema":{"type":"array","items":{"type":"string"}},"in":"query","name":"language","description":"Targeting: array of language IDs (e.g. "en", "de", ..)."}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"subscriptions\": 123,\n \"inactiveSubscriptions\": 123\n}","schema":{"title":"Success-Response:","type":"object","properties":{"subscriptions":{"type":"number","description":""},"inactiveSubscriptions":{"type":"number"}},"required":["subscriptions"]}}},"description":"Success-Response:"}}}},"/channel/{id}/subscriptions":{"get":{"tags":["Channels"],"summary":"GetChannelSubscriptions","description":"Get channel subscriptions","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"The channel id","required":true},{"schema":{"type":"array","items":{"type":"string"}},"in":"query","name":"subscriptionIds","description":"Array of subscription IDs"},{"schema":{"type":"string"},"in":"query","name":"startId","description":"Start subscription ID (it will only work if you have not passed subscriptionIds)"},{"schema":{"type":"string"},"in":"query","name":"endId","description":"End subscription ID (it will only work if you have not passed subscriptionIds)"},{"schema":{"type":"array","items":{"type":"string"}},"in":"query","name":"fields","description":"Provide additional fields (can contain: customAttributes, tags, topics, segments, country, language, createdAt, clickedDates). Wait time until response will increase if more fields will be requested."},{"schema":{"type":"string"},"in":"query","name":"since","description":"Return only subscriptions created since specified UNIX timestamp (in milliseconds). Can use either since or updatedSince."},{"schema":{"type":"string"},"in":"query","name":"updatedSince","description":"Return only subscriptions last updated since specified UNIX timestamp (in milliseconds). Can use either since or updatedSince."},{"schema":{"type":"array","items":{"type":"string"}},"in":"query","name":"tags","description":"Targeting: array of tag IDs."},{"schema":{"type":"array","items":{"type":"string"}},"in":"query","name":"topics","description":"Targeting: array of topic IDs."},{"schema":{"type":"array","items":{"type":"string"}},"in":"query","name":"segments","description":"Targeting: array of segment IDs."},{"schema":{"type":"string"},"in":"query","name":"customAttributes[user_id]","description":"Targeting: Search for subscriptions with custom attribute user_id"},{"schema":{"type":"string"},"in":"query","name":"onlyUnsubscribed","description":"For email channels: Return only unsubscribed subscriptions"}],"responses":{"200":{"content":{"application/json":{"example":" HTTP/1.1 200 OK\n {\n \"subscriptions\": [\n {\n \"_id\" : \"XXXXXXXXXXXXXX\",\n \"createdAt\" : \"2022-01-11T10:44:30.866Z\",\n \"syncedAt\" : \"2022-01-11T11:41:06.181Z\",\n \"channel\" : \"XXXXXXXXXXXXXX\",\n \"browserType\" : \"Chrome\",\n \"browserVersion\" : \"97\",\n \"platformName\" : \"Mac OS\",\n \"platformVersion\" : \"10\",\n \"language\" : \"de\",\n \"country\" : \"DE\",\n \"timezone\" : \"Europe/Berlin\",\n \"inactive\" : false,\n \"topics\" : [],\n \"type\" : \"web\",\n \"segments\" : []\n }\n ]\n}","schema":{"title":"Success-Response:","type":"object","properties":{"subscriptions":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"createdAt":{"type":"string"},"syncedAt":{"type":"string"},"channel":{"type":"string"},"browserType":{"type":"string"},"browserVersion":{"type":"string"},"platformName":{"type":"string"},"platformVersion":{"type":"string"},"language":{"type":"string"},"country":{"type":"string"},"timezone":{"type":"string"},"inactive":{"type":"boolean"},"topics":{"type":"array","items":{}},"type":{"type":"string"},"segments":{"type":"array","items":{}}}},"description":"Array of subscriptions connected to specified channel
"}},"required":["subscriptions"]}}},"description":"Success-Response:"}}}},"/channel/{id}/subscriptions/update":{"post":{"tags":["Channels"],"summary":"GetChannelUpdateSubscriptions","description":"Mass update subscriptions","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"The channel id","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"success\": true,\n \"updated\": 123,\n \"skippedProtected\": 0\n}","schema":{"title":"Success-Response:","type":"object","properties":{"success":{"type":"boolean"},"updated":{"type":"number","description":""},"skippedProtected":{"type":"number","description":"Number of update entries that targeted an overwrite-protected attribute and were left unchanged because no forceOverwrite was provided.
"}},"required":["updated","skippedProtected"]}}},"description":"Success-Response:"}},"requestBody":{"content":{"application/json":{"schema":{"title":"Remove subscription segments by using attribute \"user_id\":","type":"object","properties":{"updates":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"value":{"type":"number"},"removeSegments":{"type":"array","items":{"type":"string"}}}},"description":"Array of updates (see example below). Maximum allowed updates per request: 50.000
"}}},"examples":{"0":{"summary":"Update an attribute by using attribute \"user_id\":","value":"{\n \"updates\": [\n { \"field\": \"customAttributes.user_id\", \"value\": 123, \"update\": { \"customAttributes.categories\": [\"CATEGORY_1\"] } }\n ]\n}"},"1":{"summary":"Update an attribute by using subscription id:","value":"{\n \"updates\": [\n { \"field\": \"_id\", \"value\": \"XXXXXXXXX\", \"update\": { \"customAttributes.user_id\": \"USER_ID\" } }\n ]\n}"},"2":{"summary":"Overwrite a protected \"user_id\" attribute by using subscription id:","value":"{\n \"updates\": [\n { \"field\": \"_id\", \"value\": \"XXXXXXXXX\", \"forceOverwrite\": true, \"update\": { \"customAttributes.user_id\": \"USER_ID\" } }\n ]\n}\n// forceOverwrite only applies to the \"user_id\" attribute and only when matching by \"_id\".\n// Without it, an overwrite-protected attribute keeps its existing value when one is already set."},"3":{"summary":"Add subscription tag by using attribute \"user_id\":","value":"{\n \"updates\": [\n { \"field\": \"customAttributes.user_id\", \"value\": 123, \"tag\": \"TAG_ID\" }\n ]\n}"},"4":{"summary":"Set subscription topics by using attribute \"user_id\":","value":"{\n \"updates\": [\n { \"field\": \"customAttributes.user_id\", \"value\": 123, \"topics\": [\"TOPIC_ID_1\", \"TOPIC_ID_2\"] }\n ]\n}"},"5":{"summary":"Add subscription topics by using attribute \"user_id\":","value":"{\n \"updates\": [\n { \"field\": \"customAttributes.user_id\", \"value\": 123, \"addTopics\": [\"TOPIC_ID_1\", \"TOPIC_ID_2\"] }\n ]\n}"},"6":{"summary":"Remove subscription topics by using attribute \"user_id\":","value":"{\n \"updates\": [\n { \"field\": \"customAttributes.user_id\", \"value\": 123, \"removeTopics\": [\"TOPIC_ID_1\", \"TOPIC_ID_2\"] }\n ]\n}"},"7":{"summary":"Set subscription tags by using subscription id:","value":"{\n \"updates\": [\n { \"field\": \"_id\", \"value\": \"XXXXXXXXX\", \"tags\": [\"TAG_ID_1\", \"TAG_ID_2\"] }\n ]\n}"},"8":{"summary":"Add subscription tags by using attribute \"user_id\":","value":"{\n \"updates\": [\n { \"field\": \"customAttributes.user_id\", \"value\": 123, \"addTags\": [\"TAG_ID_1\", \"TAG_ID_2\"] }\n ]\n}"},"9":{"summary":"Remove subscription tags by using attribute \"user_id\":","value":"{\n \"updates\": [\n { \"field\": \"customAttributes.user_id\", \"value\": 123, \"removeTags\": [\"TAG_ID_1\", \"TAG_ID_2\"] }\n ]\n}"},"10":{"summary":"Add subscription tags by externalId using attribute \"user_id\":","value":"{\n \"updates\": [\n { \"field\": \"customAttributes.user_id\", \"value\": 123, \"addTagExternalIds\": [\"EXT_TAG_ID_1\", \"EXT_TAG_ID_2\"] }\n ]\n}"},"11":{"summary":"Remove subscription tags by externalId using attribute \"user_id\":","value":"{\n \"updates\": [\n { \"field\": \"customAttributes.user_id\", \"value\": 123, \"removeTagExternalIds\": [\"EXT_TAG_ID_1\", \"EXT_TAG_ID_2\"] }\n ]\n}"},"12":{"summary":"Add single tag by externalId using attribute \"user_id\":","value":"{\n \"updates\": [\n { \"field\": \"customAttributes.user_id\", \"value\": 123, \"tagExternalId\": \"EXT_TAG_ID_1\" }\n ]\n}"},"13":{"summary":"Set subscription segments by using subscription id:","value":"{\n \"updates\": [\n { \"field\": \"_id\", \"value\": \"XXXXXXXXX\", \"segments\": [\"SEGMENT_ID_1\", \"SEGMENT_ID_2\"] }\n ]\n}"},"14":{"summary":"Add subscription segments by using attribute \"user_id\":","value":"{\n \"updates\": [\n { \"field\": \"customAttributes.user_id\", \"value\": 123, \"addSegments\": [\"SEGMENT_ID_1\", \"SEGMENT_ID_2\"] }\n ]\n}"},"15":{"summary":"Remove subscription segments by using attribute \"user_id\":","value":"{\n \"updates\": [\n { \"field\": \"customAttributes.user_id\", \"value\": 123, \"removeSegments\": [\"SEGMENT_ID_1\", \"SEGMENT_ID_2\"] }\n ]\n}"}}}},"description":"Remove subscription segments by using attribute \"user_id\":"}}},"/channel/{id}/follow-up-campaign/{campaignId}":{"get":{"tags":["Channels"],"summary":"GetFollowUpCampaign","description":"Get follow up campaign","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"Channel ID","required":true},{"schema":{"type":"string"},"in":"path","name":"campaignId","description":"Follow up campaign ID","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"_id\": \"xxx\",\n \"name\": \"xxx\",\n \"notifications\": [\n {\n \"_id\": \"xxxxxxxxxxxx\",\n \"title\": \"xxxxxxxxxxxx\",\n \"url\": \"http://cleverpush.com\",\n \"sent\": 0,\n \"delivered\": 0,\n \"clicked\": 0\n }\n ]\n}","schema":{"title":"Success-Response:","type":"object","properties":{"_id":{"type":"string"},"name":{"type":"string"},"notifications":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"},"sent":{"type":"number"},"delivered":{"type":"number"},"clicked":{"type":"number"}}}},"campaign":{"type":"object","properties":{},"description":"Object with targetted campaign data corresponding to channel
"}},"required":["campaign"]}}},"description":"Success-Response:"}}}},"/channel/{id}/follow-up-campaigns":{"get":{"tags":["Channels"],"summary":"GetFollowUpCampaigns","description":"Get follow up campaigns","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"Channel ID","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"campaigns\": [\n {\n \"_id\": \"xxxxxxxxxxx\",\n \"name\": \"xxxxxxxxxx\"\n }\n ]\n}","schema":{"title":"Success-Response:","type":"object","properties":{"campaigns":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"name":{"type":"string"}}},"description":"Array of Objects containing data for each campaign corresponding to the channel
"}},"required":["campaigns"]}}},"description":"Success-Response:"}}}},"/channel/{id}/geo-fence/{geoFenceId}":{"get":{"tags":["Channels"],"summary":"GetGeoFence","description":"Get geo fence","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"Channel ID","required":true},{"schema":{"type":"string"},"in":"path","name":"geoFenceId","description":"Geo Fence ID","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"_id\": \"xxx\",\n \"name\": \"xxx\",\n \"latitude\": 1.0000,\n \"longitude\": 1.0000,\n \"radius\": 500\n}","schema":{"title":"Success-Response:","type":"object","properties":{"_id":{"type":"string"},"name":{"type":"string"},"latitude":{"type":"number"},"longitude":{"type":"number"},"radius":{"type":"number"},"geoFence":{"type":"object","properties":{},"description":"Object containing data about targetted geographical information
"}},"required":["geoFence"]}}},"description":"Success-Response:"}}}},"/channel/{id}/geo-fences":{"get":{"tags":["Channels"],"summary":"GetGeoFences","description":"Get geo fences","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"Channel ID","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"geoFences\": [\n {\n \"_id\": \"xxxxxxxxxxx\",\n \"name\": \"xxxxxxxxxx\",\n \"latitude\": 1.0000,\n \"longitude\": 1.0000,\n \"radius\": 500\n }\n ]\n}","schema":{"title":"Success-Response:","type":"object","properties":{"geoFences":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"name":{"type":"string"},"latitude":{"type":"number"},"longitude":{"type":"number"},"radius":{"type":"number"}}},"description":"Array of geographical informations corresponding to the specified channel
"}},"required":["geoFences"]}}},"description":"Success-Response:"}}}},"/channel/{id}/stories":{"get":{"tags":["Channels"],"summary":"GetStories","description":"Get stories","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"The channel id","required":true},{"schema":{"type":"string"},"in":"query","name":"limit","description":"Used for pagination. Default: 50, Max: 100"},{"schema":{"type":"string"},"in":"query","name":"skip","description":"Used for pagination. Default: 0"},{"schema":{"type":"string"},"in":"query","name":"category","description":"Used for filter category"}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"stories\": [\n {\n \"_id\": \"xxxxxxxxxxx\",\n \"title\": \"xxxxxxxxxx\",\n \"content\": {},\n \"content.pages\": [{}],\n \"code\": \" ...\"\n }\n ]\n}","schema":{"title":"Success-Response:","type":"object","properties":{"stories":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"title":{"type":"string"},"content":{"type":"object","properties":{}},"content.pages":{"type":"array","items":{"type":"object","properties":{}}},"code":{"type":"string"}}},"description":"Array of Objects representing stories data for specified channel
"}},"required":["stories"]}}},"description":"Success-Response:"}}}},"/channel/{id}/story/{storyId}":{"get":{"tags":["Channels"],"summary":"GetStory","description":"Get story","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"Channel ID","required":true},{"schema":{"type":"string"},"in":"path","name":"storyId","description":"Story ID","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"_id\": \"xxx\",\n \"name\": \"xxx\"\n}","schema":{"title":"Success-Response:","type":"object","properties":{"_id":{"type":"string"},"name":{"type":"string"},"story":{"type":"object","properties":{},"description":"Object containing data for a specified channel story
"}},"required":["story"]}}},"description":"Success-Response:"}}}},"/channel/{id}/conversations":{"get":{"tags":["Chat"],"summary":"GetConversations","description":"Get conversations","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"Channel ID","required":true},{"schema":{"type":"string"},"in":"query","name":"archived","description":"Archived conversations"},{"schema":{"type":"string"},"in":"query","name":"offset","description":"How many conversations to skip. Default: 0"},{"schema":{"type":"string"},"in":"query","name":"limit","description":"How many conversations to get. Default: 10"},{"schema":{"type":"string"},"in":"query","name":"startDate","description":"Start date timestamp"},{"schema":{"type":"string"},"in":"query","name":"endDate","description":"End date timestamp"},{"schema":{"type":"string"},"in":"query","name":"filterBy","description":"('updatedAt' | 'createdAt') which field you want to filter with date. By default: 'createdAt' (it will only work when you have passed startDate and endDate)"}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"conversations\": [\n {\n \"id\": \"cxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"channel\": \"cxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"name\": \"Conversation name\",\n \"lastMsgSeen\": true,\n \"updatedAt\": \"2022-02-01T00:00:00.000Z\",\n \"lastMsg\": \"The mass of the present is wise, and not from the valley of the sniper, but not from want.\",\n \"archived\": false,\n \"isGuest\": false,\n \"createdAt\": \"2022-01-01T00:00:00.000Z\",\n \"status\": \"active\",\n \"phone\": \"+49********13\",\n \"type\": \"whatsapp\"\n },\n {\n \"id\": \"cxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"channel\": \"cxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"name\": \"Conversation name\",\n \"lastMsgSeen\": true,\n \"updatedAt\": \"2022-02-01T00:00:00.000Z\",\n \"lastMsg\": \"The mass of the present is wise, and not from the valley of the sniper, but not from want.\",\n \"archived\": false,\n \"isGuest\": false,\n \"createdAt\": \"2022-01-01T00:00:00.000Z\",\n \"status\": \"inactive\"\n }\n ],\n \"count\": 2\n}","schema":{"title":"Success-Response:","type":"object","properties":{"conversations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"channel":{"type":"string"},"name":{"type":"string"},"lastMsgSeen":{"type":"boolean"},"updatedAt":{"type":"string"},"lastMsg":{"type":"string"},"archived":{"type":"boolean"},"isGuest":{"type":"boolean"},"createdAt":{"type":"string"},"status":{"type":"string"},"phone":{"type":"string"},"type":{"type":"string"}},"required":["id","channel","name","lastMsgSeen","updatedAt","lastMsg","archived","isGuest","createdAt","status"]},"description":"array
"},"count":{"type":"number"}},"required":["conversations"]}}},"description":"Success-Response:"}}}},"/channel/{id}/conversation/{conversationId}/messages":{"get":{"tags":["Chat"],"summary":"GetMessages","description":"Get messages","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"Channel ID","required":true},{"schema":{"type":"string"},"in":"path","name":"conversationId","description":"Conversation ID","required":true},{"schema":{"type":"string"},"in":"query","name":"offset","description":"How many messages to skip. Default: 0"},{"schema":{"type":"string"},"in":"query","name":"limit","description":"How many messages to get. Default: 10"},{"schema":{"type":"string"},"in":"query","name":"startDate","description":"Start date timestamp"},{"schema":{"type":"string"},"in":"query","name":"endDate","description":"End date timestamp"}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"messages\": [\n {\n \"id\": \"cxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"channel\": \"cxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"name\": \"John Doe\",\n \"fromChannel\": true,\n \"createdAt\": \"2022-01-01T00:00:00.000Z\",\n \"text\": \"The mass of the present is wise, and not from the valley of the sniper, but not from want.\",\n \"read\": true,\n \"conversation\": \"cxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"phone\": \"+49*********13\"\n },\n {\n \"id\": \"cxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"channel\": \"cxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"name\": \"Jack Denial\",\n \"fromChannel\": false,\n \"createdAt\": \"2022-01-01T00:00:00.000Z\",\n \"text\": \"The mass of the present is wise, and not from the valley of the sniper, but not from want.\",\n \"read\": false,\n \"conversation\": \"cxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\"\n }\n ],\n \"count\": 2\n}","schema":{"title":"Success-Response:","type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"channel":{"type":"string"},"name":{"type":"string"},"fromChannel":{"type":"boolean"},"createdAt":{"type":"string"},"text":{"type":"string"},"read":{"type":"boolean"},"conversation":{"type":"string"},"phone":{"type":"string"}},"required":["id","channel","name","fromChannel","createdAt","text","read","conversation"]},"description":"array
"},"count":{"type":"number"}},"required":["messages"]}}},"description":"Success-Response:"}}}},"/":{"get":{"tags":["Class_definitions"],"summary":"MessengerReactionAction","description":"MessengerReactionAction","parameters":[],"responses":{"200":{"content":{"application/json":{"example":"{\n \"type\": \"reaction\",\n \"title\": \"😂\"\n}","schema":{"title":"{","type":"object","properties":{"type":{"type":"string"},"title":{"type":"string"},"messengerReactionAction":{"type":"object","properties":{}}},"required":["messengerReactionAction"]}}},"description":"{"}}}},"/channel/{id}/deep-links":{"post":{"tags":["Deep_Links"],"summary":"CreateDeepLink","description":"Create Deep link","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"The channel id","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"id\": \"xxxxxxxxxxxxxxx\"\n}","schema":{"title":"Success-Response:","type":"object","properties":{"id":{"type":"string","description":""}},"required":["id"]}}},"description":"Success-Response:"}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"shortLinkUrlPath":{"type":"string","description":"Short link url path
"},"iosBehavior":{"type":"string","description":"Ios Behavior
"},"androidBehavior":{"type":"string","description":"Android Behavior
"},"fallbackUrl":{"type":"string","description":"Fallback Url
"},"androidDeepLinkUrl":{"type":"string","description":"Android Deep Link Url
"},"iosDeepLinkUrl":{"type":"string","description":"Ios Deep Link Url
"},"utmParams":{"type":"object","properties":{"utmSource":{"type":"string","description":"Utm Source
"},"utmMedium":{"type":"string","description":"Utm Medium
"},"utmCampaign":{"type":"string","description":"Utm Campaign
"}},"description":"Utm Params
"}},"type":"object","required":["shortLinkUrlPath","iosBehavior","androidBehavior","fallbackUrl"]}}}}},"get":{"tags":["Deep_Links"],"summary":"GetDeepLinks","description":"Get Deep links","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"The channel id","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"deepLinks\": [\n {\n \"_id\": \"xxxxxxxxxxxxxxxxx\",\n \"shortLinkUrlPath\":\"/param\",\n \"androidDeepLinkUrl\":\"https://example.com\",\n \"iosDeepLinkUrl\":\"https://example.com\",\n \"url\":\"https://example.com\",\n \"iosBehavior\":\"string\",\n \"androidBehavior\":\"string\",\n \"utmParams\":{\n \"utmSource\":\"string\",\n \"utmMedium\":\"string\",\n \"utmCampaign\":\"string\"\n },\n \"fallbackUrl\":\"https://example.com\",\n \"channel\":\"xxxxxxxxxxxxxxxxx\",\n \"createdAt\":\"2018-01-01T12:00:00.000Z\",\n \"clicked\":0\n }\n ]\n}","schema":{"title":"Success-Response:","type":"object","properties":{"deepLinks":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string","description":"Deep Link ID
"},"shortLinkUrlPath":{"type":"string","description":"Short link url path
"},"androidDeepLinkUrl":{"type":"string","description":"Android Deep Link Url
"},"iosDeepLinkUrl":{"type":"string","description":"Ios Deep Link Url
"},"url":{"type":"string","description":"Deep link url
"},"iosBehavior":{"type":"string","description":"Ios Behavior
"},"androidBehavior":{"type":"string","description":"Android Behavior
"},"utmParams":{"type":"object","properties":{"utmSource":{"type":"string","description":"Utm Source
"},"utmMedium":{"type":"string","description":"Utm Medium
"},"utmCampaign":{"type":"string","description":"Utm Campaign
"}},"description":"Utm Params
","required":["utmSource","utmMedium","utmCampaign"]},"fallbackUrl":{"type":"string","description":"Fallback Url
"},"channel":{"type":"string","description":"Channel's ID
"},"createdAt":{"type":"string","description":"Created date
"},"clicked":{"type":"string","description":"Click count
"}},"required":["_id","channel","shortLinkUrlPath","iosBehavior","url","androidBehavior","androidDeepLinkUrl","iosDeepLinkUrl","utmParams","fallbackUrl","clicked","createdAt"]},"description":"Array of Objects with deep link data
"}},"required":["deepLinks"]}}},"description":"Success-Response:"}}}},"/channel/{channelid}/deep-link/{id}":{"delete":{"tags":["Deep_Links"],"summary":"DeleteDeepLink","description":"Delete Deep link","parameters":[{"schema":{"type":"string"},"in":"path","name":"channelid","description":"The channel id","required":true},{"schema":{"type":"string"},"in":"path","name":"id","description":"The deep link id","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"success\": true\n}","schema":{"title":"Success-Response:","type":"object","properties":{"success":{"type":"boolean","description":""}},"required":["success"]}}},"description":"Success-Response:"}}},"get":{"tags":["Deep_Links"],"summary":"GetDeepLink","description":"Get Deep link","parameters":[{"schema":{"type":"string"},"in":"path","name":"channelid","description":"The channel id","required":true},{"schema":{"type":"string"},"in":"path","name":"id","description":"The deep link id","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"deepLink\": {\n \"_id\": \"xxxxxxxxxxxxxxxxx\",\n \"shortLinkUrlPath\": \"/param\",\n \"androidDeepLinkUrl\":\"https://example.com\",\n \"iosDeepLinkUrl\":\"https://example.com\",\n \"url\":\"https://example.com\",\n \"iosBehavior\":\"string\",\n \"androidBehavior\":\"string\",\n \"utmParams\": {\n \"utmSource\":\"string\",\n \"utmMedium\":\"string\",\n \"utmCampaign\":\"string\"\n },\n \"fallbackUrl\":\"https://example.com\",\n \"channel\":\"xxxxxxxxxxxxxxxxx\",\n \"createdAt\":\"2018-01-01T12:00:00.000Z\",\n \"clicked\":0\n }\n}","schema":{"title":"Success-Response:","type":"object","properties":{"deepLink":{"type":"object","properties":{"_id":{"type":"string","description":"Deep Link ID
"},"shortLinkUrlPath":{"type":"string","description":"Short link url path
"},"androidDeepLinkUrl":{"type":"string","description":"Android Deep Link Url
"},"iosDeepLinkUrl":{"type":"string","description":"Ios Deep Link Url
"},"url":{"type":"string","description":"Deep link url
"},"iosBehavior":{"type":"string","description":"Ios Behavior
"},"androidBehavior":{"type":"string","description":"Android Behavior
"},"utmParams":{"type":"object","properties":{"utmSource":{"type":"string","description":"Utm Source
"},"utmMedium":{"type":"string","description":"Utm Medium
"},"utmCampaign":{"type":"string","description":"Utm Campaign
"}},"description":"Utm Params
","required":["utmSource","utmMedium","utmCampaign"]},"fallbackUrl":{"type":"string","description":"Fallback Url
"},"channel":{"type":"string","description":"Channel's ID
"},"createdAt":{"type":"string","description":"Created date
"},"clicked":{"type":"string","description":"Click count
"}},"description":"Object with targetted deep link data
","required":["_id","channel","shortLinkUrlPath","androidDeepLinkUrl","iosDeepLinkUrl","iosBehavior","androidBehavior","url","utmParams","fallbackUrl","clicked","createdAt"]}},"required":["deepLink"]}}},"description":"Success-Response:"}}},"post":{"tags":["Deep_Links"],"summary":"UpdateDeepLink","description":"Update Deep link","parameters":[{"schema":{"type":"string"},"in":"path","name":"channelid","description":"The channel id","required":true},{"schema":{"type":"string"},"in":"path","name":"id","description":"The deep link id","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"success\": true\n}","schema":{"title":"Success-Response:","type":"object","properties":{"success":{"type":"boolean","description":""}},"required":["success"]}}},"description":"Success-Response:"}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"channel":{"type":"string","description":"Channel's ID
"},"shortLinkUrlPath":{"type":"string","description":"Short link url path
"},"androidBehavior":{"type":"string","description":"Android Behavior
"},"iosBehavior":{"type":"string","description":"Ios Behavior
"},"url":{"type":"string","description":"Deep link url
"},"fallbackUrl":{"type":"string","description":"Fallback Url
"},"androidDeepLinkUrl":{"type":"string","description":"Android Deep Link Url
"},"iosDeepLinkUrl":{"type":"string","description":"Ios Deep Link Url
"},"utmParams":{"type":"object","properties":{"utmSource":{"type":"string","description":"Utm Source
"},"utmMedium":{"type":"string","description":"Utm Medium
"},"utmCampaign":{"type":"string","description":"Utm Campaign
"}},"description":"Utm Params
"}},"type":"object","required":["channel","shortLinkUrlPath","androidBehavior","iosBehavior","url","fallbackUrl"]}}}}}},"/channel/{channelId}/email/set-attributes":{"get":{"tags":["Email"],"summary":"EmailSetAttributes","description":"Set subscription attributes via email link","parameters":[{"schema":{"type":"string"},"in":"path","name":"channelId","description":"The ID of the channel","required":true},{"schema":{"type":"string"},"in":"query","name":"subscriptionId","description":"The subscription ID to set attributes for","required":true},{"schema":{"type":"string"},"in":"query","name":"redirectUrl","description":"URL to redirect to after setting attributes. Use 'doubleOptIn' to redirect to the email confirmation page"},{"schema":{"type":"string"},"in":"query","name":"customAttributes","description":"Custom attributes to set using bracket notation (e.g., customAttributes[user_id]=123&customAttributes[firstname]=Max)"}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"success\": true,\n \"attributesSet\": 2\n}","schema":{"title":"Success-Response (without redirect):","type":"object","properties":{"success":{"type":"boolean"},"attributesSet":{"type":"number"}}}}},"description":"Success-Response (without redirect):"}}}},"/channel/{id}/email-opt-in-forms":{"get":{"tags":["Email"],"summary":"Get_all_email_opt-in_forms","description":"Get all email opt-in forms","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"The channel id","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"emailOptInForms\": [\n {\n \"channels\": [\"xxxxx\"],\n \"name\": \"xxxxx\",\n \"fields\": [{}],\n \"emailOptInRoutineId\": \"xxxxx\",\n \"checkboxEnabled\": false,\n \"checkboxText\": \"xxxxx\",\n \"tags\": [\"xxxxx\"],\n \"headlineStyle\": {},\n \"descriptionStyle\": {},\n \"fieldStyle\": {},\n \"labelStyle\": {},\n \"inputStyle\": {},\n \"buttonStyle\": {},\n \"buttonContent\": \"xxxxx\",\n \"topicStyle\": {},\n \"topicElementStyle\": {},\n \"enabledEditOptInForm\": false,\n \"emailTemplateId\": \"xxxxx\",\n \"editOptInFormFields\": [{}],\n \"createdAt\": \"2021-06-24T00:00:00.000+0000\"\n }\n ]\n}","schema":{"title":"Success-Response:","type":"object","properties":{"emailOptInForms":{"type":"array","items":{"type":"object","properties":{"channels":{"type":"array","items":{"type":"string"}},"name":{"type":"string"},"fields":{"type":"array","items":{"type":"object","properties":{}}},"emailOptInRoutineId":{"type":"string"},"checkboxEnabled":{"type":"boolean"},"checkboxText":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"headlineStyle":{"type":"object","properties":{}},"descriptionStyle":{"type":"object","properties":{}},"fieldStyle":{"type":"object","properties":{}},"labelStyle":{"type":"object","properties":{}},"inputStyle":{"type":"object","properties":{}},"buttonStyle":{"type":"object","properties":{}},"buttonContent":{"type":"string"},"topicStyle":{"type":"object","properties":{}},"topicElementStyle":{"type":"object","properties":{}},"enabledEditOptInForm":{"type":"boolean"},"emailTemplateId":{"type":"string"},"editOptInFormFields":{"type":"array","items":{"type":"object","properties":{}}},"createdAt":{"type":"string"}}},"description":"Array of objects with email opt-in forms data
"}},"required":["emailOptInForms"]}}},"description":"Success-Response:"}}}},"/channel/{id}/email-opt-in-routines":{"get":{"tags":["Email"],"summary":"Get_all_email_opt-in_routines","description":"Get all email opt-in routines","parameters":[{"schema":{"type":"string"},"in":"header","name":"Authorization","description":"Private API key","required":true},{"schema":{"type":"string"},"in":"path","name":"id","description":"The channel id","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"emailOptInRoutines\": [\n {\n \"channels\": [\"xxxxx\"],\n \"name\": \"xxxxx\",\n \"subject\": \"xxxxx\",\n \"emailAccountId\": \"xxxxx\",\n \"smsProviderId\": \"xxxxx\",\n \"content\": \"xxxxx\",\n \"contentState\": {},\n \"pendingPageUrl\": \"xxxxx\",\n \"successPageUrl\": \"xxxxx\",\n \"createdAt\": \"2021-06-24T00:00:00.000+0000\"\n }\n ]\n}","schema":{"title":"Success-Response:","type":"object","properties":{"emailOptInRoutines":{"type":"array","items":{"type":"object","properties":{"channels":{"type":"array","items":{"type":"string"}},"name":{"type":"string"},"subject":{"type":"string"},"emailAccountId":{"type":"string"},"smsProviderId":{"type":"string"},"content":{"type":"string"},"contentState":{"type":"object","properties":{}},"pendingPageUrl":{"type":"string"},"successPageUrl":{"type":"string"},"createdAt":{"type":"string"}}},"description":"Array of objects with email opt-in routines data
"}},"required":["emailOptInRoutines"]}}},"description":"Success-Response:"}}}},"/email-accounts/create":{"post":{"tags":["Email_accounts"],"summary":"Create_email_Account","description":"Create email account","parameters":[],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"id\": \"xxx\"\n}","schema":{"title":"Success-Response:","type":"object","properties":{"id":{"type":"string","description":""}},"required":["id"]}}},"description":"Success-Response:"}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"channels":{"items":{"type":"string","description":"ChannelIds of the email account
"},"type":"array","description":"ChannelIds of the email account
"},"hostName":{"type":"string","description":"The email hostname.
"},"port":{"type":"number","description":"The email port.
"},"username":{"type":"string","description":"The email username.
"},"password":{"type":"string","description":"The email password.
"},"email":{"type":"string","description":"The email address.
"},"name":{"type":"string","description":"The sender name.
"}},"type":"object","required":["channels","hostName","port","username","password","email","name"]}}}}}},"/email-accounts/{id}":{"delete":{"tags":["Email_accounts"],"summary":"Delete_email_account","description":"Delete email account","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"The email account id","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"success\": true\n}","schema":{"title":"Success-Response:","type":"object","properties":{"success":{"type":"boolean","description":""}},"required":["success"]}}},"description":"Success-Response:"}}},"post":{"tags":["Email_accounts"],"summary":"Update_email_account","description":"Update email account","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"The email account id","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"success\": true\n}","schema":{"title":"Success-Response:","type":"object","properties":{"success":{"type":"boolean","description":""}},"required":["success"]}}},"description":"Success-Response:"}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"channels":{"items":{"type":"string","description":"ChannelIds of the email account
"},"type":"array","description":"ChannelIds of the email account
"},"hostName":{"type":"string","description":"The email hostname.
"},"port":{"type":"number","description":"The email port.
"},"username":{"type":"string","description":"The email username.
"},"password":{"type":"string","description":"The email password.
"},"email":{"type":"string","description":"The email address.
"},"name":{"type":"string","description":"The sender name.
"}},"type":"object"}}}}}},"/email-accounts/":{"get":{"tags":["Email_accounts"],"summary":"Get_email_accounts","description":"Get all email accounts","parameters":[],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"emailAccounts\": [\n {\n \"channels\": [],\n \"hostName\": \"xxx\",\n \"port\": 0,\n \"username\": \"xxx\",\n \"password\": \"xxx\",\n \"email\": \"xxx\",\n \"name\": \"xxx\",\n \"createdAt\": \"2021-06-24T00:00:00.000+0000\",\n \"updatedAt\": \"2021-06-24T00:00:00.000+0000\"\n }\n ]\n}","schema":{"title":"Success-Response:","type":"object","properties":{"emailAccounts":{"type":"array","items":{"type":"object","properties":{"channels":{"type":"array","items":{}},"hostName":{"type":"string"},"port":{"type":"number"},"username":{"type":"string"},"password":{"type":"string"},"email":{"type":"string"},"name":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}},"description":"Array of objects with email account data
"}},"required":["emailAccounts"]}}},"description":"Success-Response:"}}}},"/channel/{id}/email-template/{templateId}":{"get":{"tags":["Email_templates"],"summary":"GetEmailTemplate","description":"Get email template","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"The channel id","required":true},{"schema":{"type":"string"},"in":"path","name":"templateId","description":"The email template id","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"template\": {\n \"_id\": \"xxxxxxxxxxxxxxxxx\",\n \"channels\": [\"xxxxxxxxxxxxxxxxx\"],\n \"name\": \"Daily Newsletter\",\n \"version\": 2,\n \"emailTemplate\": {\n \"subject\": \"Daily Newsletter\",\n \"content\": {\n \"elements\": [\n {\n \"id\": \"html-block\",\n \"type\": \"html\",\n \"content\": \"\\u003c!-- DAILY_BLOCK_START --\\u003e...
\\u003c!-- DAILY_BLOCK_END --\\u003e\"\n }\n ]\n }\n }\n }\n}","schema":{"title":"Success-Response:","type":"object","properties":{"template":{"type":"object","properties":{"_id":{"type":"string"},"channels":{"type":"array","items":{"type":"string"}},"name":{"type":"string"},"version":{"type":"number"},"emailTemplate":{"type":"object","properties":{"subject":{"type":"string"},"content":{"type":"object","properties":{"elements":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"content":{"type":"string"}}}}}}}}},"description":"The requested email template document.
"}},"required":["template"]}}},"description":"Success-Response:"}}},"patch":{"tags":["Email_templates"],"summary":"UpdateEmailTemplate","description":"Update email template","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"The channel id","required":true},{"schema":{"type":"string"},"in":"path","name":"templateId","description":"The email template id","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"success\": true\n}","schema":{"title":"Success-Response:","type":"object","properties":{"success":{"type":"boolean","description":"True if the template was updated successfully.
"}},"required":["success"]}}},"description":"Success-Response:"}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"name":{"type":"string","description":"The template name.
"},"subject":{"type":"string","description":"The email subject.
"},"preHeader":{"type":"string","description":"The email preheader.
"},"content":{"type":"object","properties":{},"description":"The structured email editor content. HTML blocks are stored in content.elements entries with type "html" and field "content".
"}},"type":"object"}}}}}},"/channel/{id}/email-template/{templateId}/html-section":{"post":{"tags":["Email_templates"],"summary":"ReplaceEmailTemplateHtmlSection","description":"Replace marked email template HTML section","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"The channel id","required":true},{"schema":{"type":"string"},"in":"path","name":"templateId","description":"The email template id","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"success\": true,\n \"jobId\": \"XXXXXXXX\"\n}","schema":{"title":"Success-Response:","type":"object","properties":{"success":{"type":"boolean","description":"True if the template was updated successfully.
"},"jobId":{"type":"string"},"replacedSections":{"type":"number","description":"Number of marked sections replaced.
"}},"required":["success","replacedSections"]}}},"description":"Success-Response:"}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"sections":{"type":"array","items":{"type":"object","properties":{"html":{"type":"string","description":"The new HTML block to inject between the markers.
"},"startMarker":{"type":"string","description":"Start marker in an editor element's content field.
"},"endMarker":{"type":"string","description":"End marker in an editor element's content field.
"}},"required":["html","startMarker","endMarker"]},"description":"Multiple HTML blocks to inject between marker pairs.
"},"html":{"type":"string","description":"Backward-compatible single HTML block to inject between the markers.
"},"startMarker":{"type":"string","description":"Backward-compatible single start marker. Default: <!-- DAILY_BLOCK_START -->
Backward-compatible single end marker. Default: <!-- DAILY_BLOCK_END -->
Replace every matching marked section instead of only the first one.
"},"processAsync":{"type":"boolean","description":"Queue the update as a worker job. Set to false for immediate local testing.
"}},"type":"object"}}}}}},"/link-statistics/export":{"post":{"tags":["Link_Statistics"],"summary":"ExportLinkStatistics","description":"Export per-link statistics","parameters":[{"schema":{"type":"string"},"in":"header","name":"authorization","description":"Private API key","required":true}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{},"type":"object","required":[]}}}}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"channelIds":{"items":{"type":"string","description":"Channel IDs (email channels only; uses all accessible email channels if empty)
"},"type":"array","description":"Channel IDs (email channels only; uses all accessible email channels if empty)
"},"startDate":{"type":"number","description":"Range start (UNIX timestamp)
"},"endDate":{"type":"number","description":"Range end (UNIX timestamp)
"},"pickedColumns":{"items":{"type":"string","description":"Optional column keys; default all; allowed values: notificationId, notificationTitle, sendDate, channelId, channelName, url, totalClicks, uniqueClicks
"},"type":"array","description":"Optional column keys; default all; allowed values: notificationId, notificationTitle, sendDate, channelId, channelName, url, totalClicks, uniqueClicks
"},"exportDateFormat":{"type":"string","description":""},"timezone":{"type":"string","description":""},"testEmail":{"type":"string","description":"Send download link to this address instead of the account email
"}},"type":"object","required":["startDate","endDate"]}}}}}},"/channel/{id}/notification-groups":{"post":{"tags":["Notification_groups"],"summary":"NotificationGroupCreate","description":"Create notification group","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"The channel id","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"success\": true,\n \"id\": \"XXXXXXXX\"\n}","schema":{"title":"Success-Response:","type":"object","properties":{"success":{"type":"boolean","description":""},"id":{"type":"string"}},"required":["success"]}}},"description":"Success-Response:"}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"name":{"type":"string","description":"The notification group name
"}},"type":"object","required":["name"]}}}}},"get":{"tags":["Notification_groups"],"summary":"NotificationGroupsGet","description":"Get notification groups","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"The channel id","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"groups\": [\n {\n \"_id\": \"xxxxxxxxxxxxxxxxx\",\n \"channel\": \"xxxxxxxxxxxxxxxxx\",\n \"name\": \"Example Group\",\n \"notifications\": 0\n }\n ]\n}","schema":{"title":"Success-Response:","type":"object","properties":{"groups":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"channel":{"type":"string"},"name":{"type":"string"},"notifications":{"type":"number"}}},"description":"Array of Groups included in notifications
"}},"required":["groups"]}}},"description":"Success-Response:"}}}},"/channel/{id}/notification-template/{templateId}":{"get":{"tags":["Notification_templates"],"summary":"GetNotificationTemplate","description":"Get notification template","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"The channel id","required":true},{"schema":{"type":"string"},"in":"path","name":"templateId","description":"The notification template id","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"template\": {\n \"_id\": \"xxxxxxxxxxxxxxxxx\",\n \"channel\": \"xxxxxxxxxxxxxxxxx\",\n \"name\": \"Example Template\",\n \"title\": \"My template\",\n \"templateGroup\": \"My Group\"\n }\n}","schema":{"title":"Success-Response:","type":"object","properties":{"template":{"type":"object","properties":{"_id":{"type":"string"},"channel":{"type":"string"},"name":{"type":"string"},"title":{"type":"string"},"templateGroup":{"type":"string","description":"The notification template group name
"}},"description":"The data of the requested notification template
","required":["templateGroup"]}},"required":["template"]}}},"description":"Success-Response:"}}},"post":{"tags":["Notification_templates"],"summary":"UpdateNotificationTemplate","description":"Update notification template","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"The channel id","required":true},{"schema":{"type":"string"},"in":"path","name":"templateId","description":"The notification template id","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"success\": true\n}","schema":{"title":"Success-Response:","type":"object","properties":{"success":{"type":"boolean","description":"True if the template was updated successfully
"}},"required":["success"]}}},"description":"Success-Response:"}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"title":{"type":"string","description":"The template's title.
"}},"type":"object"}}}}}},"/channel/{id}/notification-templates":{"post":{"tags":["Notification_templates"],"summary":"NotificationTemplateCreate","description":"Create notification template","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"The channel id","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"success\": true,\n \"id\": \"XXXXXXXX\"\n}","schema":{"title":"Success-Response:","type":"object","properties":{"success":{"type":"boolean","description":""},"id":{"type":"string"}},"required":["success"]}}},"description":"Success-Response:"}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"title":{"type":"string","description":"The notification title.
"},"name":{"type":"string","description":"The notification name.
"},"text":{"type":"string","description":"The notification text.
"},"url":{"type":"string","description":"The notification URL.
"},"iconUrl":{"type":"string","description":"The notification's icon.
"},"mediaUrl":{"type":"string","description":"The notification's large media/image.
"},"actions":{"items":{"type":"string","description":"Array of action objects: { title, url, [icon] }.
"},"type":"array","description":"Array of action objects: { title, url, [icon] }.
"}},"type":"object"}}}}},"get":{"tags":["Notification_templates"],"summary":"NotificationTemplatesGet","description":"Get notification templates","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"The channel id","required":true},{"schema":{"type":"string"},"in":"query","name":"limit","description":"Used for pagination. Default: 50, Max: 100"},{"schema":{"type":"string"},"in":"query","name":"skip","description":"Used for pagination. Default: 0"},{"schema":{"type":"string","default":"true"},"in":"query","name":"sourcecode","description":"Include HTML source code in the response. Set to false to return template metadata only."}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"templates\": [\n {\n \"_id\": \"xxxxxxxxxxxxxxxxx\",\n \"channel\": \"xxxxxxxxxxxxxxxxx\",\n \"name\": \"Example Template\",\n \"title\": \"My template\",\n \"templateGroup\": \"My Group\"\n }\n ]\n}","schema":{"title":"Success-Response:","type":"object","properties":{"templates":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"channel":{"type":"string"},"name":{"type":"string"},"title":{"type":"string"},"templateGroup":{"type":"string","description":"The notification template group name
"}},"required":["templateGroup"]},"description":"Array with data for notification templates corresponding to the specified channel
"}},"required":["templates"]}}},"description":"Success-Response:"}}}},"/channel/{id}/notification-campaign":{"post":{"tags":["Notifications"],"summary":"CreateNotificationCampaign","description":"Create Notification campaign","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"The channel id","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"success\": true,\n \"notificationCampaignId\": \"xxxxxxxxxx\"\n}","schema":{"title":"Success-Response:","type":"object","properties":{"success":{"type":"boolean"},"notificationCampaignId":{"type":"string"},"Object":{"type":"object","properties":{},"description":"api suceess response and notification campaign id
"}},"required":["Object"]}}},"description":"Success-Response:"}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"name":{"type":"string","description":"Name for new notification campaign
"},"externalId":{"type":"string","description":"External ID for the campaign (optional)
"}},"type":"object","required":["name"]}}}}}},"/channel/{channelId}/notification/{id}":{"delete":{"tags":["Notifications"],"summary":"DeleteChannelNotification","description":"Delete notification","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"The notification id","required":true},{"schema":{"type":"string"},"in":"path","name":"channelId","description":"The channel id","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"success\": true\n}","schema":{"title":"Success-Response:","type":"object","properties":{"success":{"type":"boolean","description":""}},"required":["success"]}}},"description":"Success-Response:"}}},"get":{"tags":["Notifications"],"summary":"GetChannelNotification","description":"Get notification","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"The notification id","required":true},{"schema":{"type":"string"},"in":"path","name":"channelId","description":"The channel id","required":true},{"schema":{"type":"string"},"in":"path","name":"fields","description":"Comma-separated list of fields to include in the response (sparse fieldsets). When omitted, the full object is returned (default, unchanged behavior). Unknown fields are ignored; _id is always included. Example: fields=_id,title,sent. Selectable fields: _id, title, text, channel, user, source, url, autoHide, socialSharingActions, createdAt, expiresAt, expiresAtHours, iconUrl, subscriptionCount, sent, optOuts, delivered, clicked, hidden, jobId, queuedAt, status, subscriptionStatistics, actions."}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"notification\": {\n \"_id\": \"xxxxxxxxxxxxxxxxx\",\n \"title\": \"Example title\",\n \"text\": \"Example text\",\n \"channel\": \"xxxxxxxxxxxxxxxxx\",\n \"user\": \"xxxxxxxxxxxxxxxxx\",\n \"source\": \"web\",\n \"url\": \"https://example.com\",\n \"autoHide\": false,\n \"socialSharingActions\": true,\n \"createdAt\": \"2018-01-01T01:00:00.000Z\",\n \"expiresAt\": \"2018-01-01T11:00:00.000Z\",\n \"expiresAtHours\": 10,\n \"iconUrl\": \"\",\n \"subscriptionCount\": 2,\n \"sent\": 2,\n \"optOuts\": 0,\n \"delivered\": 2,\n \"clicked\": 1,\n \"hidden\": false,\n \"jobId\": \"123456\",\n \"queuedAt\": \"2018-01-01T01:00:00.000Z\",\n \"status\": \"sent\",\n \"subscriptionStatistics\": { \"browser\": { \"Chrome\": 2 }, \"platform\": { \"Windows\": 1, \"Android\": 1 }, \"language\": { \"en\": 2 }, \"country\": { \"US\": 2 } },\n \"actions\": [ { \"clicked\": 0 }, { \"clicked\": 1 } ]\n }\n}","schema":{"title":"Success-Response:","type":"object","properties":{"notification":{"type":"object","properties":{"_id":{"type":"string"},"title":{"type":"string"},"text":{"type":"string"},"channel":{"type":"string"},"user":{"type":"string"},"source":{"type":"string"},"url":{"type":"string"},"autoHide":{"type":"boolean"},"socialSharingActions":{"type":"boolean"},"createdAt":{"type":"string"},"expiresAt":{"type":"string"},"expiresAtHours":{"type":"number"},"iconUrl":{"type":"string"},"subscriptionCount":{"type":"number"},"sent":{"type":"number"},"optOuts":{"type":"number"},"delivered":{"type":"number"},"clicked":{"type":"number"},"hidden":{"type":"boolean"},"jobId":{"type":"string"},"queuedAt":{"type":"string"},"status":{"type":"string"},"subscriptionStatistics":{"type":"object","properties":{"browser":{"type":"object","properties":{"Chrome":{"type":"number"}}},"platform":{"type":"object","properties":{"Windows":{"type":"number"},"Android":{"type":"number"}}},"language":{"type":"object","properties":{"en":{"type":"number"}}},"country":{"type":"object","properties":{"US":{"type":"number"}}}}},"actions":{"type":"array","items":{"type":"object","properties":{"clicked":{"type":"number"}},"required":["clicked"]}}},"description":"Object containing data for a single notification connected to specified channel
"}},"required":["notification"]}}},"description":"Success-Response:"}}},"post":{"tags":["Notifications"],"summary":"UpdateChannelNotification","description":"Update notification","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"The notification id","required":true},{"schema":{"type":"string"},"in":"path","name":"channelId","description":"The channel id","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"success\": true\n}","schema":{"title":"Success-Response:","type":"object","properties":{"success":{"type":"boolean","description":""}},"required":["success"]}}},"description":"Success-Response:"}},"requestBody":{"content":{"application/json":{"schema":{"properties":{},"type":"object"}}}}}},"/channel/{id}/notification-campaign/{campaignId}":{"delete":{"tags":["Notifications"],"summary":"DeleteNotificationCampaign","description":"Delete Notification campaign","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"The channel id","required":true},{"schema":{"type":"string"},"in":"path","name":"campaignId","description":"The notification campaign id","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"success\": true\n}","schema":{"title":"Success-Response:","type":"object","properties":{"success":{"type":"boolean","description":""}},"required":["success"]}}},"description":"Success-Response:"}}},"get":{"tags":["Notifications"],"summary":"GetNotificationCampaign","description":"Get Notification campaign","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"The channel id","required":true},{"schema":{"type":"string"},"in":"path","name":"campaignId","description":"The notification campaign id","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"_id\": \"xxxxxxxxxxx\",\n \"name\": \"xxxxxxxxxx\",\n \"channel\": \"xxxxxxxxxx\",\n \"queuedAt\": \"xxxxxxxxxx\",\n \"sent\": \"xxx\"\n}","schema":{"title":"Success-Response:","type":"object","properties":{"_id":{"type":"string"},"name":{"type":"string"},"channel":{"type":"string"},"queuedAt":{"type":"string"},"sent":{"type":"string"},"Object":{"type":"object","properties":{},"description":"containing data for individual notification campaign corresponding to the channel
"}},"required":["Object"]}}},"description":"Success-Response:"}}},"post":{"tags":["Notifications"],"summary":"UpdateNotificationCampaign","description":"Update Notification campaign","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"The channel id","required":true},{"schema":{"type":"string"},"in":"path","name":"campaignId","description":"The notification campaign id","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"success\": true\n}","schema":{"title":"Success-Response:","type":"object","properties":{"success":{"type":"boolean","description":""}},"required":["success"]}}},"description":"Success-Response:"}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"name":{"type":"string","description":"Updated name of campaign
"}},"type":"object","required":["name"]}}}}}},"/channel/{id}/notification-campaigns":{"delete":{"tags":["Notifications"],"summary":"DeleteNotificationCampaigns","description":"Delete Notification campaigns","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"Channel ID","required":true},{"schema":{"type":"string"},"in":"query","name":"campaignIds","description":"Array of campaign ids to be deleted","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"success\": true\n}","schema":{"title":"Success-Response:","type":"object","properties":{"success":{"type":"boolean","description":""}},"required":["success"]}}},"description":"Success-Response:"}}},"get":{"tags":["Notifications"],"summary":"GetNotificationCampaigns","description":"Get Notification campaigns","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"Channel ID","required":true},{"schema":{"type":"string"},"in":"query","name":"offset","description":"How many campaigns to skip. Default: 0"},{"schema":{"type":"string"},"in":"query","name":"limit","description":"How many campaigns to get. Default: 10"}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"notificationCampaigns\": [\n {\n \"_id\": \"xxxxxxxxxxx\",\n \"name\": \"xxxxxxxxxx\",\n \"channel\": \"xxxxxxxxxx\",\n \"queuedAt\": \"xxxxxxxxxx\",\n \"sent\": \"xxx\"\n }\n ],\n \"count\": \"xx\"\n}","schema":{"title":"Success-Response:","type":"object","properties":{"notificationCampaigns":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"name":{"type":"string"},"channel":{"type":"string"},"queuedAt":{"type":"string"},"sent":{"type":"string"}}}},"count":{"type":"string"},"Object":{"type":"object","properties":{},"description":"containing array and total count for notification campaigns corresponding to the channel
"}},"required":["Object"]}}},"description":"Success-Response:"}}},"post":{"tags":["Notifications"],"summary":"UpdateNotificationCampaigns","description":"Create Notification campaigns","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"Channel ID","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"success\": true\n}","schema":{"title":"Success-Response:","type":"object","properties":{"success":{"type":"boolean","description":""}},"required":["success"]}}},"description":"Success-Response:"}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"campaginUpdates":{"type":"array","items":{"type":"object","properties":{}},"description":"Array of object containing campaign "_id" and "name" field
"}},"type":"object","required":["campaginUpdates"]}}}}}},"/channel/{channelId}/notification/{id}/events":{"get":{"tags":["Notifications"],"summary":"GetChannelNotificationEvents","description":"Get notification events","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"The notification id","required":true},{"schema":{"type":"string"},"in":"path","name":"channelId","description":"The channel id","required":true},{"schema":{"type":"string"},"in":"query","name":"type","description":"Optionally specify an event type. Valid types: clicked, delivered, opened (only for email channels)"},{"schema":{"type":"string"},"in":"query","name":"pageToken","description":"Optionally specify a page token from a previous response to fetch the next page. One response will always return max. 5000 results."}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"events\": [\n {\n \"notification\": \"XXXXXXXX\",\n \"type\": \"clicked\",\n \"subscription\": \"XXXXXXXX\",\n \"date\": \"2020-08-22T20:28:29.976Z\"\n }\n ],\n \"pageToken\": \"...\"\n}","schema":{"title":"Success-Response:","type":"object","properties":{"events":{"type":"array","items":{"type":"object","properties":{"notification":{"type":"string"},"type":{"type":"string"},"subscription":{"type":"string"},"date":{"type":"string"}}}},"pageToken":{"type":"string"},"success":{"type":"boolean","description":""}},"required":["success"]}}},"description":"Success-Response:"}}}},"/channel/{channelId}/notification/{id}/hourly-statistics":{"get":{"tags":["Notifications"],"summary":"GetChannelNotificationHourlyStatistics","description":"Get hourly notification statistics","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"The notification id","required":true},{"schema":{"type":"string"},"in":"path","name":"channelId","description":"The channel id","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"statistics\": [\n {\n \"notification\": \"XXXXXXXXXXXX\",\n \"date\": \"2020-.....\",\n \"hour\": 1,\n \"clicked\": 10\n }\n ]\n}","schema":{"title":"Success-Response:","type":"object","properties":{"statistics":{"type":"array","items":{"type":"object","properties":{"notification":{"type":"string"},"date":{"type":"string"},"hour":{"type":"number"},"clicked":{"type":"number"}}}},"success":{"type":"boolean","description":""}},"required":["success"]}}},"description":"Success-Response:"}}}},"/channel/{id}/notifications":{"get":{"tags":["Notifications"],"summary":"GetChannelNotifications","description":"Get notifications","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"The channel id","required":true},{"schema":{"type":"string"},"in":"query","name":"limit","description":"How many notifications to get. Default: 50. Maximum: 5000"},{"schema":{"type":"string"},"in":"query","name":"offset","description":"How many notifications to skip. Default: 0"},{"schema":{"type":"string"},"in":"query","name":"noTransactional","description":"Does not output notifications which were tagged as 'transactional'"},{"schema":{"type":"string"},"in":"query","name":"status","description":"Shows all notifications if not set. Possible values: 'sent', 'sending', 'scheduled', 'queued', 'failed'"},{"schema":{"type":"array","items":{"type":"string"}},"in":"query","name":"externalId","description":"Include only notifications which match the specified externalId. The external ID can be provided in the /notification/send endpoint. (can be array of external IDs or string)"},{"schema":{"type":"array","items":{"type":"string"}},"in":"query","name":"topics","description":"Include only notifications which match the specified topics. (can be array of topics or string)"},{"schema":{"type":"string"},"in":"query","name":"startDate","description":"Start date UNIX timestamp (seconds), reflects to queuedAt field"},{"schema":{"type":"string"},"in":"query","name":"endDate","description":"End date UNIX timestamp (seconds), reflects to queuedAt field"},{"schema":{"type":"string"},"in":"query","name":"fields","description":"Comma-separated list of fields to include in the response (sparse fieldsets). When omitted, the full object is returned (default, unchanged behavior). Unknown fields are ignored; _id is always included. Example: fields=_id,title,sent. Selectable fields: _id, title, text, channel, user, source, url, autoHide, socialSharingActions, createdAt, expiresAt, expiresAtHours, iconUrl, subscriptionCount, sent, optOuts, delivered, clicked, hidden, jobId, queuedAt, status, subscriptionStatistics, actions."}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"notifications\": [\n {\n \"_id\": \"xxxxxxxxxxxxxxxxx\",\n \"title\": \"Example title\",\n \"text\": \"Example text\",\n \"channel\": \"xxxxxxxxxxxxxxxxx\",\n \"user\": \"xxxxxxxxxxxxxxxxx\",\n \"source\": \"web\",\n \"url\": \"https://example.com\",\n \"autoHide\": false,\n \"socialSharingActions\": true,\n \"createdAt\": \"2018-01-01T01:00:00.000Z\",\n \"expiresAt\": \"2018-01-01T11:00:00.000Z\",\n \"expiresAtHours\": 10,\n \"iconUrl\": \"\",\n \"subscriptionCount\": 2,\n \"sent\": 2,\n \"optOuts\": 0,\n \"delivered\": 2,\n \"clicked\": 1,\n \"hidden\": false,\n \"jobId\": \"123456\",\n \"templateId\": \"xxxxxxxxxxxxxxxxx\",\n \"queuedAt\": \"2018-01-01T01:00:00.000Z\",\n \"status\": \"sent\",\n \"subscriptionStatistics\": { \"browser\": { \"Chrome\": 2 }, \"platform\": { \"Windows\": 1, \"Android\": 1 }, \"language\": { \"en\": 2 }, \"country\": { \"US\": 2 } },\n \"actions\": [ {\"title\": \"Action 1\", \"clicked\": 0 } ]\n }\n ]\n}","schema":{"title":"Success-Response:","type":"object","properties":{"notifications":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"title":{"type":"string","description":"notification's title
"},"text":{"type":"string","description":"notification's HTML text
"},"channel":{"type":"string","description":"channel's ID
"},"user":{"type":"string","description":"user's ID
"},"source":{"type":"string","description":"type of source
"},"url":{"type":"string","description":"notification's url
"},"autoHide":{"type":"boolean","description":"auto hide feature
"},"socialSharingActions":{"type":"boolean","description":"show social sharing actions
"},"createdAt":{"type":"string","description":"date of creation of notifications
"},"expiresAt":{"type":"string","description":"date of expiry of notifications
"},"expiresAtHours":{"type":"number","description":"remaining time of expire in hours
"},"iconUrl":{"type":"string","description":"url of notification icon image
"},"subscriptionCount":{"type":"number","description":"number of subscriptions of notification
"},"sent":{"type":"number","description":"number of sent of notification
"},"optOuts":{"type":"number","description":"number of optOuts of notification
"},"delivered":{"type":"number","description":"number of delivered of notification
"},"clicked":{"type":"number","description":"number of clicked of notification
"},"hidden":{"type":"boolean","description":"notification hidden
"},"jobId":{"type":"string","description":"notification's job ID
"},"templateId":{"type":"string","description":"notification's template ID
"},"queuedAt":{"type":"string","description":"date of creation of notifications
"},"status":{"type":"string","description":"status of notifications
"},"subscriptionStatistics":{"type":"object","properties":{"browser":{"type":"object","properties":{"Chrome":{"type":"number"},"chrome":{"type":"number","description":"number of notification's subscription on crome
"}},"description":"statistics of notification's subscription on browser
","required":["chrome"]},"platform":{"type":"object","properties":{"Windows":{"type":"number"},"Android":{"type":"number"},"windows":{"type":"number","description":"number of notification's subscription on Windows
"},"android":{"type":"number","description":"number of notification's subscription on Android
"}},"description":"statistics of notification's subscription on different platform
","required":["windows","android"]},"language":{"type":"object","properties":{"en":{"type":"number","description":"number of notification's subscription on English
"}},"description":"statistics of notification's subscription on language spoken
","required":["en"]},"country":{"type":"object","properties":{"US":{"type":"number"},"us":{"type":"number","description":"number of notification's subscription on US
"}},"description":"statistics of notification's subscription on country
","required":["us"]}},"description":"statistics of notification's subscription
","required":["browser","platform","language","country"]},"actions":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string","description":"title of article
"},"clicked":{"type":"number","description":"clicked count of article
"}},"required":["title","clicked"]},"description":"Array of object including title of article and clicked count
"},"id":{"type":"string","description":"notification's ID
"}},"required":["id","title","text","channel","user","source","url","autoHide","socialSharingActions","createdAt","expiresAt","expiresAtHours","iconUrl","subscriptionCount","sent","optOuts","delivered","clicked","hidden","jobId","queuedAt","status","subscriptionStatistics","actions"]},"description":"Array of notifications for a specified channel
"}},"required":["notifications"]}}},"description":"Success-Response:"}}}},"/notification/send":{"post":{"tags":["Notifications"],"summary":"SendNotification","description":"Create notification","parameters":[],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"error\": \"subscription not found\"\n}","schema":{"title":"Error-Response:","type":"object","properties":{"error":{"type":"string"},"success":{"type":"boolean","description":""},"notificationId":{"type":"string","description":""}},"required":["success","notificationId"]}}},"description":"Error-Response:"}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"channelId":{"type":"string","description":"The channel ID.
"},"title":{"type":"string","description":"The notification title (subject for email channels).
"},"text":{"type":"string","description":"The notification text (HTML body for email channels). For custom HTML newsletters, embed AD SLOT placeholders as merge tags: {{adSlot_<slotId>}} where slotId is the EmailAdSlots document ID (e.g. {{adSlot_xYz123AbC}}). Placeholders are resolved with configured ad campaign content at send time.
The notification URL.
"},"iconUrl":{"type":"string","description":"The notification's icon.
"},"mediaUrl":{"type":"string","description":"The notification's large media/image.
"},"fetchMediaUrl":{"type":"boolean","description":"Fetches a mediaUrl from the provided url if no mediaUrl is provided.
"},"scheduledAt":{"type":"number","description":"A unix timestamp for scheduling notifications (must be in the future).
"},"expiresAtHours":{"type":"number","description":"Hours after the notification will expire.
"},"expiresAtMinutes":{"type":"number","description":"Alternatively: Minutes after the notification will expire.
"},"balancedDeliveryType":{"type":"string","description":"Evenly distribute delivery type, can be 'balancedDeliveryMinutes' or 'balancedDeliverySendings'
"},"balancedDeliveryMinutes":{"type":"number","description":"Evenly distribute delivery in these minutes instead of sending to all subscriptions instantly.
"},"balancedDeliverySendings":{"type":"number","description":"Distribute delivery in specified number per minute instead of sending to all subscriptions instantly.
"},"customData":{"type":"object","properties":{},"description":"Custom data payload which will be sent to the devices.
"},"subscriptionId":{"type":"string","description":"The subscription ID(s) (string or alternatively an array of strings). Will broadcast to all subscriptions if not given. If an array is provided, the maximum amount of items in this array is 50000.
"},"testSubscriptions":{"type":"boolean","description":"If true, will ignore other targeting settings and only send to defined test subscriptions.
"},"customAttributes":{"type":"object","properties":{},"description":"Targeting: An object of custom attributes to filter subscriptions (e.g.: { user_id: 123 } OR { user_id: [123, 124] }). Will broadcast to all subscriptions if not given.
"},"tags":{"items":{"type":"string","description":"Targeting: array of tag IDs.
"},"type":"array","description":"Targeting: array of tag IDs.
"},"tagsLogic":{"type":"string","description":"One of: 'and', 'or', default: 'or'
"},"excludeTags":{"items":{"type":"string","description":"Targeting: array of tag IDs.
"},"type":"array","description":"Targeting: array of tag IDs.
"},"externalTags":{"items":{"type":"string","description":"Targeting: array of tag IDs.
"},"type":"array","description":"Targeting: array of tag IDs.
"},"excludeExternalTags":{"items":{"type":"string","description":"Targeting: array of tag IDs.
"},"type":"array","description":"Targeting: array of tag IDs.
"},"topics":{"items":{"type":"string","description":"Targeting: array of topic IDs.
"},"type":"array","description":"Targeting: array of topic IDs.
"},"topicsLogic":{"type":"string","description":"One of: 'and', 'or', default: 'or'
"},"excludeTopics":{"items":{"type":"string","description":"Targeting: array of topic IDs.
"},"type":"array","description":"Targeting: array of topic IDs.
"},"excludeTopicsLogic":{"type":"string","description":"One of: 'and', 'or', default: 'or'
"},"segments":{"items":{"type":"string","description":"Targeting: array of segment IDs.
"},"type":"array","description":"Targeting: array of segment IDs.
"},"segmentsLogic":{"type":"string","description":"One of: 'and', 'or', default: 'or'
"},"excludeSegments":{"items":{"type":"string","description":"Targeting: array of segment IDs.
"},"type":"array","description":"Targeting: array of segment IDs.
"},"excludeSegmentsLogic":{"type":"string","description":"One of: 'and', 'or', default: 'or'
"},"platform":{"items":{"type":"string","description":"Targeting: array of platform names (case-sensitive, e.g. "Android", "Mac OS", ..).
"},"type":"array","description":"Targeting: array of platform names (case-sensitive, e.g. "Android", "Mac OS", ..).
"},"platformLogic":{"type":"string","description":"One of: 'include', 'exclude', default: 'include'
"},"browser":{"items":{"type":"string","description":"Targeting: array of browser names (case-sensitive, e.g. "Chrome", "Firefox", ..).
"},"type":"array","description":"Targeting: array of browser names (case-sensitive, e.g. "Chrome", "Firefox", ..).
"},"browserLogic":{"type":"string","description":"One of: 'include', 'exclude', default: 'include'
"},"country":{"items":{"type":"string","description":"Targeting: array of country IDs (e.g. "US", "DE", ..).
"},"type":"array","description":"Targeting: array of country IDs (e.g. "US", "DE", ..).
"},"countryLogic":{"type":"string","description":"One of: 'include', 'exclude', default: 'include'
"},"language":{"items":{"type":"string","description":"Targeting: array of language IDs (e.g. "en", "de", ..).
"},"type":"array","description":"Targeting: array of language IDs (e.g. "en", "de", ..).
"},"languageLogic":{"type":"string","description":"One of: 'include', 'exclude', default: 'include'
"},"actions":{"items":{"type":"string","description":"Array of action objects: { title, url, [icon] }.
"},"type":"array","description":"Array of action objects: { title, url, [icon] }.
"},"groups":{"items":{"type":"string","description":"Array of notification group ids. Used for e.g. tracking similar notifications.
"},"type":"array","description":"Array of notification group ids. Used for e.g. tracking similar notifications.
"},"clickAssignTags":{"items":{"type":"string","description":"Array of notification tag ids, which are automatically assigned to subscriptions when the notification has been clicked.
"},"type":"array","description":"Array of notification tag ids, which are automatically assigned to subscriptions when the notification has been clicked.
"},"clickAssignTopics":{"items":{"type":"string","description":"Array of notification topic ids, which are automatically assigned to subscriptions when the notification has been clicked.
"},"type":"array","description":"Array of notification topic ids, which are automatically assigned to subscriptions when the notification has been clicked.
"},"socialSharingActions":{"type":"boolean","description":"Use pre-defined social sharing actions. Hint: 'actions' will be ignored if 'socialSharingActions' is given.
"},"autoHide":{"type":"boolean","description":"Automatically hide notification after approx. 20 seconds (only available for Web Push)
"},"bounceUrl":{"type":"string","description":"Set a bounce URL for this notification
"},"campaignId":{"type":"string","description":"Campaign id for later analysis
"},"externalCampaignId":{"type":"string","description":"External campaign id. If provided, will find or create a NotificationCampaign by externalId and channel. If campaign exists, its _id will be used as campaignId. If not, a new campaign will be created with the provided campaignName (or externalCampaignId as fallback).
"},"campaignName":{"type":"string","description":"Campaign name for later analysis
"},"category":{"type":"string","description":"Android Notification Category ID
"},"transactional":{"type":"boolean","description":"Tags the notification as transactional message, just used for filtering in the backoffice
"},"breakingNews":{"type":"boolean","description":"Marks the notification as breaking news (bypasses daily/hourly per-subscription push limits, higher queue priority on Enterprise). Requires a plan with breaking news enabled. Ignored otherwise.
"},"translationsEnabled":{"type":"boolean","description":"Enable per-language notification content. With A/B testing, translations belong on each variant (Notification → A/B variant → translations).
"},"abTesting":{"type":"boolean","description":"Optionally enable A/B testing
"},"testVariants":{"type":"array","items":{"type":"object","properties":{"translations":{"type":"object","properties":{},"description":"Per-language content for this variant, e.g. { "de": { "title": "...", "text": "..." } }. Hierarchy is Notification → A/B variant → translations.
"}}},"description":"Array of objects. An object can consist of the fields you want to test (title, text, ...). When used with translationsEnabled, nest per-language content under testVariants.translations.
"},"abTestingAutoCompare":{"type":"boolean","description":"Optionally compares the best notification after 30 minutes and sends the best result to the rest
"},"abTestingPercent":{"type":"number","description":"A/B test percentage (0 to 100)
"},"machineLearning":{"type":"boolean","description":"Optionally enable machine learning (available for Enterprise plans).
"},"machineLearningMinimumPercentage":{"type":"number","description":"Minimum percentage of total subscriptions to send to if the ML algorithm does not find enough subscriptions (rest of the subscriptions are filled up).
"},"walletPass":{"type":"string","description":"Optionally set Wallet Pass ID
"},"silent":{"type":"boolean","description":"Set this to true if you want to send a silent notification (only available for App Push)
"},"soundFilename":{"type":"string","description":"Optionally set iOS sound filename
"},"soundVolume":{"type":"number","description":"Optionally set iOS sound volume (0.0 to 1.0)
"},"soundCritical":{"type":"boolean","description":"Optionally set iOS sound critical (warning: only for pre-approved apps, see: https://developer.apple.com/contact/request/notifications-critical-alerts-entitlement/)
"},"bestDeliveryTime":{"type":"boolean","description":"Enables the optimal delivery time for this message (will deliver 7 days by default, set bestDeliveryTime24Hours: true to send for 24 hours only)
"},"bestDeliveryTime24Hours":{"type":"boolean","description":"Enables the optimal delivery time for 24 hours (bestDeliveryTime needs to be true for this to work)
"},"priority":{"type":"string","description":"Optionally set priority. Possible values: "high" or "normal". Defaults to "high".
"},"templateId":{"type":"string","description":"Set the Notification / Email Template ID instead of using "text" for specifiy the content
"},"additionalAttributes":{"type":"object","properties":{},"description":"Provide additional attributes for each subscription, that will be replaced as placeholders automatically (e.g. { "XXXXXXX1": { "first_name": "John" }, "XXXXXXX2": { "first_name": "Sam" } }). The keys of this object represent the Subscription ID's by default. You can also use an indexed custom attribute for this (e.g. "user_id"), by specifying the parameter "additionalAttributesKey". Only available for transactional notifications. Max. subscriptions per request: 5000.
"},"additionalAttributesKey":{"type":"string","description":"When using "additionalAttributes", the keys of this object represent the Subscription ID's by default. You can specify a indexed custom attribute for this here (e.g. "user_id"). Only available for transactional notifications.
"},"emailNewsletter":{"type":"boolean","description":"Optionally set this to true to send email newsletters. Use "title" for the email subject and "text" for the HTML content.
"},"emailContentType":{"type":"string","description":"Email content type for custom HTML newsletters. Use "html" when sending custom HTML via text.
Set the Email Account ID
"},"emailSenderName":{"type":"string","description":"Set the Email Sender Name
"},"emailRecipient":{"type":"string","description":"Transactional Emails: Specify the recipient's email address(es) (string or alternatively an array of strings) instead of using a subscriptionId
"},"smsProvider":{"type":"string","description":"Set the SMS Provider ID
"},"phoneNumber":{"type":"string","description":"Transactional SMS: Specify the recipient's phone number(s) (string or alternatively an array of strings) in E.164 format instead of using a subscriptionId
"},"subscriptionAttributes":{"type":"object","properties":{},"description":"Transactional Emails/SMS: When using Emails with templateId: Specify the subscription's custom attributes which will be replaced as variables in the template fields.
"},"collapseKey":{"type":"string","description":"Multiple notifications with the same collapse key will be automatically replaced.
"},"threadId":{"type":"string","description":"Multiple notifications with the same thread ID will be automatically grouped together. (Supported only for iOS right now)
"},"interruptionLevel":{"type":"string","description":"Interruption levels indicate the priority and delivery timing of a notification, to 'interrupt' the user. Up until iOS 15, Apple primarily focused on Critical notifications. Now they have expanded this to include the following four levels: ['active', 'passive', 'time-sensitive', 'critical'].
"},"relevanceScore":{"type":"string","description":"A Relevance Score is a score to be set per notification to indicate how it should be displayed when grouped. The system uses the relevance score, a value between 0 and 1, to sort the notifications from your app. The highest score gets featured in the notification summary. This was introduced in iOS15+. Expected values [0, 0.75, 0.5, 0.25, 1]
"},"whatsappTemplateName":{"type":"string","description":"Name of the WhatsApp Template (required when channel type is Whatsapp)
"},"externalId":{"type":"string","description":"Used for checking for API notification duplicates internally when the corresponding setting is enabled in the channel settings.
"},"iosCategory":{"type":"object","properties":{},"description":"iOS notification category, which is available as categoryIdentifier in the app. It will not work together with the actions field, as the SDK will then dynamically generate a fitting category to display the notification buttons.
iOS Live Activity Content state
"},"iosLiveActivityEvent":{"type":"string","description":"iOS Live Activity Event ("update", "end")
"},"type":{"type":"string","description":"Notification type ("iosLiveActivity")
"},"iosLiveActivityDismissalDate":{"type":"string","description":"ios Live Activity Dismissal Date (Use Epoch Timestamp in string)
"},"appBannerId":{"type":"string","description":"App Banner ID If silent:true and the appBannerId is provided, then after the subscriber receives the notification and opens the app, it will show the appbanner
"},"autoHandleDeepLink":{"type":"boolean","description":"Used for automatic handling of Deep Links (only available for App Push)
"},"chatNotification":{"type":"boolean","description":"Used for defining notifications as "Chat notification" which will be shown in the ChatView, if used (only available for Web / App Push)
"},"chatMessage":{"type":"string","description":"Used for defining the message to be shown in the ChatView, if used (only available for Web / App Push)
"},"testSubscriptionsConsiderTargeting":{"type":"boolean","description":"Test subscriptions will be considered
"}},"type":"object","required":["channelId"]}}}}}},"/notification/send/bulk":{"post":{"tags":["Notifications"],"summary":"SendNotifications","description":"Create notifications in bulk","parameters":[],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n[\n {\n \"error\": \"subscription not found\"\n }\n]","schema":{"title":"Error-Response: Set","type":"array","items":{"type":"object","properties":{"error":{"type":"string"}},"title":"Error-Response:"},"properties":{"responses":{"type":"array","items":{"type":"object","properties":{}},"description":"Array of success objects with notificationId
"}},"required":["responses"]}}},"description":"Error-Response:"}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"channelId":{"type":"string","description":"The channel ID to which every notification will be send if no channelId defined the notification
"},"channelIds":{"items":{"type":"string","description":"List of channel IDs to which every notification will be send if no channelId defined the notification
"},"type":"array","description":"List of channel IDs to which every notification will be send if no channelId defined the notification
"},"notifications":{"type":"array","items":{"type":"object","properties":{}},"description":"Array of notifications with the same structure as notification/send, if no channelId oder channelIds are defined it will default to the channelId or channelIds directly defined in the request body. Maximum supported notifications per request: 500.
"}},"type":"object","required":["notifications"]}}}}}},"/notification/upload-media":{"post":{"tags":["Notifications"],"summary":"Upload_Media","description":"Upload Media","parameters":[{"schema":{"type":"string"},"in":"header","name":"Authorization","description":"Private API key","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"url\": \"https://static.cleverpush.com/notification/icon/...\"\n}","schema":{"title":"Success-Response:","type":"object","properties":{"url":{"type":"string"},"Url":{"type":"string","description":"to uploaded file
"}},"required":["Url"]}}},"description":"Success-Response:"}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"contentType":{"type":"string","description":"The mime type of the file
"},"payload":{"type":"string","description":"Base64 encoded file
"}},"type":"object","required":["contentType","payload"]}}}}}},"/projects/":{"get":{"tags":["Projects"],"summary":"Get_projects_accounts","description":"Get all projects","parameters":[],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"projects\": [\n {\n \"_id\": \"xxx\",\n \"user\": \"xxx\",\n \"name\": \"xxx\",\n \"starred\": false,\n \"industry\": \"xxx\",\n \"iconUrl\": \"xxx\",\n \"iconFile\": \"xxx\",\n \"createdAt\": \"2021-06-24T00:00:00.000+0000\",\n \"updatedAt\": \"2021-06-24T00:00:00.000+0000\",\n \"lastVisited\": \"2021-06-24T00:00:00.000+0000\",\n \"markedForDeletion\": false\n }\n ]\n}","schema":{"title":"Success-Response:","type":"object","properties":{"projects":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"user":{"type":"string"},"name":{"type":"string"},"starred":{"type":"boolean"},"industry":{"type":"string"},"iconUrl":{"type":"string"},"iconFile":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"lastVisited":{"type":"string"},"markedForDeletion":{"type":"boolean"}}},"description":"Array of objects with project data
"}},"required":["projects"]}}},"description":"Success-Response:"}}}},"/projects/{id}/subscriptions":{"get":{"tags":["Projects"],"summary":"Get_projects_subscriptions","description":"Get subscriptions of same project","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"The project id","required":true},{"schema":{"type":"string"},"in":"query","name":"customAttributes[user_id]","description":"Custom attribute user_id","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n\"subscriptions\": [\n {\n \"_id\": \"XXXXX1\",\n \"type\": \"app\",\n \"platformName\": \"iOS\",\n \"topics\": [\"TOPIC_ID_1\", \"TOPIC_ID_2\"]\n },\n {\n \"_id\": \"XXXXX2\",\n \"type\": \"web\",\n \"platformName\": \"Windows\",\n \"topics\": []\n }\n ]\n}","schema":{"title":"Success-Response:","type":"object","properties":{"subscriptions":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"type":{"type":"string"},"platformName":{"type":"string"},"topics":{"type":"array","items":{"type":"string"}}},"required":["_id","type","platformName","topics"]},"description":"Array of objects with subscription data
"}},"required":["subscriptions"]}}},"description":"Success-Response:"}}},"put":{"tags":["Projects"],"summary":"Update_project_subscriptions","description":"Update subscriptions of same project","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"The project id","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"modified\": 2,\n \"success\": true\n}","schema":{"title":"Success-Response:","type":"object","properties":{"modified":{"type":"number"},"success":{"type":"boolean"},"Success":{"type":"boolean","description":""}},"required":["Success"]}}},"description":"Success-Response:"}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"subscriptions":{"type":"array","items":{"type":"object","properties":{}},"description":"The modified subscriptions array
"}},"type":"object","required":["subscriptions"]}}}}}},"/projects/{id}":{"post":{"tags":["Projects"],"summary":"Update_project","description":"Update project","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"success\": true\n}","schema":{"title":"Success-Response:","type":"object","properties":{"success":{"type":"boolean","description":""}},"required":["success"]}}},"description":"Success-Response:"}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"name":{"type":"string","description":"The project name.
"},"starred":{"type":"boolean","description":"Is the project starred.
"},"industry":{"type":"string","description":"The industry category.
"},"iconUrl":{"type":"string","description":"The icon url.
"},"iconFile":{"type":"string","description":"The icon file name.
"}},"type":"object"}}}}}},"/sms-providers/create":{"post":{"tags":["SMS_providers"],"summary":"Create_SMS_provider","description":"Create SMS provider","parameters":[],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"id\": \"xxx\"\n}","schema":{"title":"Success-Response:","type":"object","properties":{"id":{"type":"string","description":""}},"required":["id"]}}},"description":"Success-Response:"}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"channels":{"items":{"type":"string","description":"ChannelIds of the smsProvider
"},"type":"array","description":"ChannelIds of the smsProvider
"},"provider":{"type":"string","description":"Provider must be twilio or websms or esendex
"},"name":{"type":"string","description":"The name you want to give to this smsProvider
"},"phone":{"type":"string","description":"The phonenumber.
"},"accountSid":{"type":"string","description":"The account SID.
"},"authToken":{"type":"string","description":"The auth token.
"},"email":{"type":"string","description":"The email.
"},"password":{"type":"string","description":"The password.
"},"accountReference":{"type":"string","description":"The account reference.
"}},"type":"object","required":["channels","provider"]}}}}}},"/sms-providers/{id}":{"delete":{"tags":["SMS_providers"],"summary":"Delete_SMS_provider","description":"Delete SMS provider","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"The sms-provider id","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"success\": true\n}","schema":{"title":"Success-Response:","type":"object","properties":{"success":{"type":"boolean","description":""}},"required":["success"]}}},"description":"Success-Response:"}}},"post":{"tags":["SMS_providers"],"summary":"Update_SMS_provider","description":"Update SMS provider","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"The sms-provider id","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"success\": true\n}","schema":{"title":"Success-Response:","type":"object","properties":{"success":{"type":"boolean","description":""}},"required":["success"]}}},"description":"Success-Response:"}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"channels":{"items":{"type":"string","description":"ChannelIds of the smsProvider
"},"type":"array","description":"ChannelIds of the smsProvider
"},"provider":{"type":"string","description":"Provider must be twilio or websms or esendex
"},"name":{"type":"string","description":"The name you want to give to this smsProvider
"},"phone":{"type":"string","description":"The phonenumber.
"},"accountSid":{"type":"string","description":"The account SID.
"},"authToken":{"type":"string","description":"The auth token.
"},"email":{"type":"string","description":"The email.
"},"password":{"type":"string","description":"The password.
"},"accountReference":{"type":"string","description":"The account reference.
"}},"type":"object"}}}}}},"/sms-providers/":{"get":{"tags":["SMS_providers"],"summary":"Get_SMS_providers","description":"Get all SMS providers","parameters":[],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"smsProviders\": [\n {\n \"channels\": [],\n \"provider\": \"xxx\",\n \"name\": \"xxx\",\n \"phone\": \"xxx\",\n \"accountSid\": \"xxx\",\n \"authToken\": \"xxx\",\n \"email\": \"xxx\",\n \"password\": \"xxx\",\n \"createdAt\": \"2021-06-24T00:00:00.000+0000\",\n \"updatedAt\": \"2021-06-24T00:00:00.000+0000\"\n }\n ]\n}","schema":{"title":"Success-Response:","type":"object","properties":{"smsProviders":{"type":"array","items":{"type":"object","properties":{"channels":{"type":"array","items":{}},"provider":{"type":"string"},"name":{"type":"string"},"phone":{"type":"string"},"accountSid":{"type":"string"},"authToken":{"type":"string"},"email":{"type":"string"},"password":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}},"description":"Array of objects with smsProviders data
"}},"required":["smsProviders"]}}},"description":"Success-Response:"}}}},"/channel/{channelId}/short-links":{"post":{"tags":["Shortlinks"],"summary":"CreateShortLink","description":"Create short link","parameters":[{"schema":{"type":"string"},"in":"path","name":"channelId","description":"The channel id","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"_id\": \"123123123\",\n \"url\": \"https://clpsh.com/12345678\"\n}","schema":{"title":"Success-Response:","type":"object","properties":{"_id":{"type":"string","description":"The ID of the created short link
"},"url":{"type":"string","description":"The full short link URL
"}},"required":["_id","url"]}}},"description":"Success-Response:"}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"url":{"type":"string","description":"The original URL to be shortened
"},"notificationId":{"type":"string","description":"The notification id
"}},"type":"object","required":["url"]}}}}}},"/channel/{channelId}/short-link/statistics":{"get":{"tags":["Shortlinks"],"summary":"GetShortLinkStatistics","description":"Get shortlink statistics","parameters":[{"schema":{"type":"string"},"in":"path","name":"channelId","description":"The channel id","required":true},{"schema":{"type":"string"},"in":"query","name":"startDate","description":"The start date of the statistics.","required":true},{"schema":{"type":"string"},"in":"query","name":"endDate","description":"The end date of the statistics (max 30 days).","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n {\n \"clicked\": 10\n }","schema":{"title":"Success-Response:","type":"object","properties":{"clicked":{"type":"number","description":"Total clicked count of the shortlink
"}},"required":["clicked"]}}},"description":"Success-Response:"}}}},"/channel/{channelId}/short-link/{shortLinkId}":{"post":{"tags":["Shortlinks"],"summary":"UpdateShortLink","description":"Update short link notification","parameters":[{"schema":{"type":"string"},"in":"path","name":"channelId","description":"The channel id","required":true},{"schema":{"type":"string"},"in":"path","name":"shortLinkId","description":"The short link id","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"success\": true\n}","schema":{"title":"Success-Response:","type":"object","properties":{"success":{"type":"boolean","description":"Indicates if the update was successful
"}},"required":["success"]}}},"description":"Success-Response:"}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"notificationId":{"type":"string","description":"The notification id to associate with the short link
"}},"type":"object","required":["notificationId"]}}}}}},"/subscription/topic/add":{"post":{"tags":["Subscriptions"],"summary":"AddTopicToSubscription","description":"Add topic to subscription","parameters":[],"responses":{"201":{"content":{"application/json":{"example":"HTTP/1.1 201 Created\n{\n \"success\": true\n}","schema":{"title":"Success-Response:","type":"object","properties":{"success":{"type":"boolean"}}}}},"description":"Success-Response:"}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"channelId":{"type":"string","description":"The channel ID.
"},"topicId":{"type":"string","description":"The topic ID.
"},"subscriptionId":{"type":"string","description":"The subscription ID.
"}},"type":"object","required":["channelId","topicId","subscriptionId"]}}}}}},"/subscription/attribute/clear":{"post":{"tags":["Subscriptions"],"summary":"ClearSubscriptionAttribute","description":"Clear a subscription attribute","parameters":[],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"success\": true\n}","schema":{"title":"Success-Response:","type":"object","properties":{"success":{"type":"boolean","description":""}},"required":["success"]}}},"description":"Success-Response:"}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"channelId":{"type":"string","description":"The channel ID.
"},"attributeId":{"type":"string","description":"The attribute ID.
"},"subscriptionId":{"type":"string","description":"The single subscription ID.
"},"subscriptionIds":{"items":{"type":"string","description":"Array of subscription IDs (maximum 1000).
"},"type":"array","description":"Array of subscription IDs (maximum 1000).
"}},"type":"object","required":["channelId","attributeId"]}}}}}},"/subscription/conversion":{"post":{"tags":["Subscriptions"],"summary":"ConversionSubscription","description":"Track conversion event","parameters":[],"responses":{"201":{"content":{"application/json":{"example":"HTTP/1.1 201 Created\n{\n \"success\": true\n}","schema":{"title":"Success-Response:","type":"object","properties":{"success":{"type":"boolean"}}}}},"description":"Success-Response:"}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"subscriptionId":{"type":"string","description":"The subscriptionId used to update the subscription's tags. (Either subscriptionId or customAttributes.user_id is required)
"},"channelId":{"type":"string","description":"The channel ID.
"},"eventId":{"type":"string","description":"The conversion event ID.
"},"properties":{"type":"object","properties":{},"description":"The conversion event properties (defined in the conversion event settings in CleverPush). Special properties named amount and currency will be used for the conversion amount.
The deep link ID associated with this conversion (for deep link statistics tracking).
"}},"type":"object","required":["subscriptionId","channelId","eventId"]}}}}}},"/subscription/event":{"post":{"tags":["Subscriptions"],"summary":"EventSubscription","description":"Emit follow-up event","parameters":[],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"success\": true\n}","schema":{"title":"Success-Response:","type":"object","properties":{"success":{"type":"boolean","description":""}},"required":["success"]}}},"description":"Success-Response:"}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"subscriptionId":{"type":"string","description":"The subscription ID.
"},"campaignId":{"type":"string","description":"The follow-up campaign ID. Either specify this or the channel ID.
"},"channelId":{"type":"string","description":"The Channel ID. Either specify this or the follow-up campagn ID.
"},"name":{"type":"string","description":"The event name.
"},"parameters":{"type":"string","description":"The event parameters.
"}},"type":"object","required":["subscriptionId","campaignId","channelId","name","parameters"]}}}}}},"/subscription/start-journey":{"post":{"tags":["Subscriptions"],"summary":"EventSubscription","description":"Emit journey event","parameters":[],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"success\": true\n}","schema":{"title":"Success-Response:","type":"object","properties":{"success":{"type":"boolean","description":""}},"required":["success"]}}},"description":"Success-Response:"}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"subscriptionId":{"type":"string","description":"The subscription ID.
"},"journeyId":{"type":"string","description":"The Journey ID. Either specify this or the channel ID.
"},"channelId":{"type":"string","description":"The Channel ID. Either specify this or the Journey ID.
"},"name":{"type":"string","description":"The event name.
"},"parameters":{"type":"string","description":"The event parameters.
"}},"type":"object","required":["subscriptionId","journeyId","channelId","name","parameters"]}}}}}},"/removed-subscriptions":{"get":{"tags":["Subscriptions"],"summary":"GetRemovedSubscriptions","description":"Get removed subscriptions","parameters":[{"schema":{"type":"string"},"in":"query","name":"channel","description":"The channel ID.","required":true},{"schema":{"type":"string"},"in":"query","name":"since","description":"From UNIX timestamp (in milliseconds)","required":true},{"schema":{"type":"string"},"in":"query","name":"until","description":"To UNIX timestamp (in milliseconds)","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"subscriptions\": [\n {\n \"subscription\": \"XXXXXXXXXXXXXXXXX\",\n \"channel\": \"XXXXXXXXXXXXXXXXX\",\n \"reason\": \"unsubscribe\",\n \"removedAt\": \"2018-01-01T12:00:00.000Z\"\n }\n ]\n}","schema":{"title":"Success-Response:","type":"object","properties":{"subscriptions":{"type":"array","items":{"type":"object","properties":{"subscription":{"type":"string"},"channel":{"type":"string"},"reason":{"type":"string"},"removedAt":{"type":"string"}}},"description":"Array with data for all removed subscriptions
"}},"required":["subscriptions"]}}},"description":"Success-Response:"}}}},"/subscription":{"get":{"tags":["Subscriptions"],"summary":"GetSubscription","description":"Get subscription","parameters":[{"schema":{"type":"string"},"in":"query","name":"channelId","description":"The Channel ID (required).","required":true},{"schema":{"type":"string"},"in":"query","name":"subscriptionId","description":"The subscription ID. Location: query parameter. Use this for direct subscription lookup in the given channel."},{"schema":{"type":"string"},"in":"query","name":"attributeId","description":"Channel attribute ID. Only supports "user_id". Must be used together with attributeValue."},{"schema":{"type":"string"},"in":"query","name":"attributeValue","description":"Subscription attribute value. Required when using attributeId."},{"schema":{"type":"string"},"in":"query","name":"emailAddress","description":"Subscription email address to search for."},{"schema":{"type":"array","items":{"type":"string"}},"in":"query","name":"fields","description":"Optional query parameter. Provide the subscription fields to include (can contain: customAttributes, tags, topics, segments, country, language, createdAt, clickedDates). If omitted, the full subscription is returned. Wait time until response will increase if more fields will be requested."}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"subscription\": {\n \"_id\" : \"XXXXXXXXXXXXXX\",\n \"createdAt\" : \"2022-01-11T10:44:30.866Z\",\n \"syncedAt\" : \"2022-01-11T11:41:06.181Z\",\n \"channel\" : \"XXXXXXXXXXXXXX\",\n \"browserType\" : \"Chrome\",\n \"browserVersion\" : \"97\",\n \"platformName\" : \"Mac OS\",\n \"platformVersion\" : \"10\",\n \"language\" : \"de\",\n \"country\" : \"RU\",\n \"timezone\" : \"Europe/Berlin\",\n \"inactive\" : false,\n \"topics\" : [],\n \"type\" : \"web\",\n \"segments\" : []}\n}","schema":{"title":"Success-Response:","type":"object","properties":{"subscription":{"type":"object","properties":{"_id":{"type":"string"},"createdAt":{"type":"string"},"syncedAt":{"type":"string"},"channel":{"type":"string"},"browserType":{"type":"string"},"browserVersion":{"type":"string"},"platformName":{"type":"string"},"platformVersion":{"type":"string"},"language":{"type":"string"},"country":{"type":"string"},"timezone":{"type":"string"},"inactive":{"type":"boolean"},"topics":{"type":"array","items":{}},"type":{"type":"string"},"segments":{"type":"array","items":{}}}},"The":{"type":"object","properties":{},"description":"subscription
"}},"required":["The"]}}},"description":"Success-Response:"},"400":{"content":{"application/json":{"example":"HTTP/1.1 400 Bad Request\n{\n \"error\": \"subscriptionId or attributeId/attributeValue or emailAddress required\"\n}","schema":{"title":"Error-Response:","type":"object","properties":{"error":{"type":"string"}}}}},"description":"Error-Response:"}}}},"/channel/{channelId}/subscription/{id}/conversions":{"get":{"tags":["Subscriptions"],"summary":"GetSubscriptionConversions","description":"Get subscription conversions","parameters":[{"schema":{"type":"string"},"in":"header","name":"Authorization","description":"Private API key","required":true},{"schema":{"type":"string"},"in":"path","name":"channelId","description":"The channel ID","required":true},{"schema":{"type":"string"},"in":"path","name":"id","description":"The subscription ID","required":true},{"schema":{"type":"string"},"in":"query","name":"eventId","description":"Optionally filter by conversion event ID"},{"schema":{"type":"string"},"in":"query","name":"limit","description":"Number of conversions per page. Default: 100."},{"schema":{"type":"string"},"in":"query","name":"pageToken","description":"Pagination token from a previous response to fetch the next page"}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"conversions\": [\n {\n \"subscription\": \"FGHjbc6txDA8AmT65\",\n \"channel\": \"ohzZqghh2jxaYaXTi\",\n \"eventId\": \"ebiZDPPzHtKHbBBrX\",\n \"notification\": \"XXXXXXXX\",\n \"date\": \"2026-07-02T11:43:40.913Z\",\n \"properties\": { \"amount\": \"12.50\", \"currency\": \"EUR\" }\n }\n ],\n \"pageToken\": \"...\"\n}","schema":{"title":"Success-Response:","type":"object","properties":{"conversions":{"type":"array","items":{"type":"object","properties":{"subscription":{"type":"string","description":"The subscription ID
"},"channel":{"type":"string","description":"The channel ID
"},"eventId":{"type":"string","description":"The conversion event ID
"},"notification":{"type":"string","description":"Associated notification ID when present
"},"date":{"type":"string","description":"ISO 8601 timestamp of the conversion
"},"properties":{"type":"object","properties":{"amount":{"type":"string"},"currency":{"type":"string"}},"description":"Conversion properties (e.g. amount, currency)
"}},"required":["subscription","channel","eventId","date","properties"]},"description":"List of recorded conversions
"},"pageToken":{"type":"string","description":"Pagination token for the next page when more results are available
"}},"required":["conversions"]}}},"description":"Success-Response:"}}}},"/channel/{channelId}/subscription/notification-events":{"get":{"tags":["Subscriptions"],"summary":"GetSubscriptionNotificationEvents","description":"Get subscription notification events","parameters":[{"schema":{"type":"string"},"in":"path","name":"channelId","description":"The channel ID.","required":true},{"schema":{"type":"string"},"in":"query","name":"subscriptionId","description":"The subscription ID to fetch events for. Location: query parameter. Required.","required":true},{"schema":{"type":"string"},"in":"query","name":"notificationId","description":"Optional. When set, restricts results to this notification ID only. When omitted, events for all notifications of the subscription are returned."},{"schema":{"type":"string"},"in":"query","name":"type","description":"Filter by a specific event type (e.g. 'delivered', 'inAppDelivered', 'clicked', 'opened', 'softBounce', 'hardBounce', 'emailSpamComplained', 'tagAdded', 'tagRemoved', 'topicAdded', 'topicRemoved', 'segmentAdded', 'segmentRemoved', 'voucherCodeSent', 'uniqueClickedLinks'). If omitted, all types are returned."},{"schema":{"type":"string"},"in":"query","name":"limit","description":"Number of events per page. Default: 100."},{"schema":{"type":"string"},"in":"query","name":"pageToken","description":"Pagination token from a previous response to fetch the next page."},{"schema":{"type":"array","items":{"type":"string"}},"in":"query","name":"fields","description":"Optional query parameter. Select response fields for each event. If omitted, the default full event response is returned. Supported event fields: subscriptionId, notificationId, type, payload, date. Additional notification fields available on request: subject, notificationTitle, notificationText, templateId, templateName."}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"events\": [\n {\n \"subscriptionId\": \"AGE9LfiSGrfSoKgEk\",\n \"notificationId\": \"DtA9TAjrH4RqHXSQb\",\n \"type\": \"delivered\",\n \"payload\": null,\n \"date\": \"2026-01-01T14:15:34.629Z\"\n }\n ],\n \"pageToken\": \"nextPageTokenString\"\n}","schema":{"title":"Success-Response:","type":"object","properties":{"events":{"type":"array","items":{"type":"object","properties":{"subscriptionId":{"type":"string","description":"The subscription ID.
"},"notificationId":{"type":"string","description":"The notification ID.
"},"type":{"type":"string","description":"The event type (e.g. 'delivered', 'clicked').
"},"payload":{"type":"string","description":"The event payload (may be null).
"},"date":{"type":"string","description":"ISO 8601 timestamp of the event.
"}},"required":["subscriptionId","notificationId","type","payload","date"]},"description":"List of notification events.
"},"pageToken":{"type":"string","description":"Pagination token for the next page. Only present when more results are available.
"}},"required":["events"]}}},"description":"Success-Response:"}}}},"/subscription/mark-as-test":{"post":{"tags":["Subscriptions"],"summary":"MarkSubscriptionAsTest","description":"Mark or Unmark Subscription As Test","parameters":[],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"success\": true\n}","schema":{"title":"Success Response:","type":"object","properties":{"success":{"type":"boolean","description":""}},"required":["success"]}}},"description":"Success Response:"},"400":{"content":{"application/json":{"example":"HTTP/1.1 400 Bad Request\n{\n \"error\": 400,\n \"message\": \"missing parameter\"\n}","schema":{"title":"Missing Parameter Response:","type":"object","properties":{"error":{"type":"number"},"message":{"type":"string"}}}}},"description":"Missing Parameter Response:"},"404":{"content":{"application/json":{"example":"HTTP/1.1 404 Not Found\n{\n \"error\": 404,\n \"message\": \"subscription not found\"\n}","schema":{"title":"Not Found Response:","type":"object","properties":{"error":{"type":"number"},"message":{"type":"string"}}}}},"description":"Not Found Response:"}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"channelId":{"type":"string","description":"The channel ID.
"},"subscriptionId":{"type":"string","description":"The subscription ID to mark or unmark as test.
"},"isTest":{"type":"boolean","description":"Set to true to mark as test, false to unmark. Defaults to true when omitted for backwards compatibility.
The channel ID.
"},"attributeId":{"type":"string","description":"The attribute ID. Possible array attribute IDs are currently only categories and products.
The attribute value. Can be a String (max length: 255 characters) or Number. If the attribute is configured to store arrays, the maximum length of the array should be 1000.
"},"subscriptionId":{"type":"string","description":"The subscription ID.
"},"subscriptionIds":{"items":{"type":"string","description":"The subscription IDs (max. 1000).
"},"type":"array","description":"The subscription IDs (max. 1000).
"}},"type":"object","required":["channelId","attributeId","value"]}}}}}},"/subscription/attribute/pull-value":{"post":{"tags":["Subscriptions"],"summary":"PushSubscriptionAttributeValue","description":"Pull value from subscription array attributes","parameters":[],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"success\": true\n}","schema":{"title":"Success-Response:","type":"object","properties":{"success":{"type":"boolean","description":""}},"required":["success"]}}},"description":"Success-Response:"}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"channelId":{"type":"string","description":"The channel ID.
"},"attributeId":{"type":"string","description":"The attribute ID. Possible array attribute IDs are currently only categories and products.
The attribute value. Can be a String (max length: 255 characters) or Number. If the attribute is configured to store arrays, the maximum length of the array should be 1000.
"},"subscriptionId":{"type":"string","description":"The subscription ID.
"},"subscriptionIds":{"items":{"type":"string","description":"The subscription IDs (max. 1000).
"},"type":"array","description":"The subscription IDs (max. 1000).
"}},"type":"object","required":["channelId","attributeId","value"]}}}}}},"/subscription/topic/remove":{"post":{"tags":["Subscriptions"],"summary":"RemoveTopicFromSubscription","description":"Remove topic from subscription","parameters":[],"responses":{"201":{"content":{"application/json":{"example":"HTTP/1.1 201 Created\n{\n \"success\": true\n}","schema":{"title":"Success-Response:","type":"object","properties":{"success":{"type":"boolean"}}}}},"description":"Success-Response:"}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"channelId":{"type":"string","description":"The channel ID.
"},"topicId":{"type":"string","description":"The topic ID to remove.
"},"subscriptionId":{"type":"string","description":"The subscription ID from which to remove the topic.
"}},"type":"object","required":["channelId","topicId","subscriptionId"]}}}}}},"/subscription/attribute":{"post":{"tags":["Subscriptions"],"summary":"SetSubscriptionAttribute","description":"Set a subscription's attribute","parameters":[],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"success\": true\n}","schema":{"title":"Success-Response:","type":"object","properties":{"success":{"type":"boolean","description":""}},"required":["success"]}}},"description":"Success-Response:"}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"channelId":{"type":"string","description":"The channel ID.
"},"attributeId":{"type":"string","description":"The attribute ID.
"},"value":{"type":"string","description":"The attribute value. Can be a String (max length: 255 characters) or Number. If the attribute is configured to store arrays, the maximum length of the array should be 1000.
"},"subscriptionId":{"type":"string","description":"The subscription ID.
"},"subscriptionIds":{"items":{"type":"string","description":"The subscription IDs (max. 1000).
"},"type":"array","description":"The subscription IDs (max. 1000).
"}},"type":"object","required":["channelId","attributeId","value"]}}}}}},"/subscription/sync/{id}":{"post":{"tags":["Subscriptions"],"summary":"SyncSubscription","description":"Sync subscription","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"The channel ID.","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"id\": \"SUBSCRIPTION_ID_HERE\"\n}","schema":{"title":"Success (Updated):","type":"object","properties":{"id":{"type":"string","description":"The Subscription ID
"}},"required":["id"]}}},"description":"Success (Updated):"},"201":{"content":{"application/json":{"example":"HTTP/1.1 201 Created\n{\n \"id\": \"SUBSCRIPTION_ID_HERE\"\n}","schema":{"title":"Success (Created):","type":"object","properties":{"id":{"type":"string"}}}}},"description":"Success (Created):"},"400":{"content":{"application/json":{"example":"HTTP/1.1 400 Bad request\n{\n \"error\": 400,\n \"message\": \"channel not found\"\n}","schema":{"title":"Error (Channel not found):","type":"object","properties":{"error":{"type":"number"},"message":{"type":"string"}}}}},"description":"Error (Channel not found):"},"404":{"content":{"application/json":{"example":"HTTP/1.1 404 Not found\n{\n \"error\": 404,\n \"message\": \"subscription not found and updateOnly mode is enabled\"\n}","schema":{"title":"Error (Update Only):","type":"object","properties":{"error":{"type":"number"},"message":{"type":"string"}}}}},"description":"Error (Update Only):"}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"subscriptionId":{"type":"string","description":"Synchronize/update an existing subscription
"},"endpoint":{"type":"string","description":"Web push subscription endpoint (for Web Push)
"},"publicKey":{"type":"string","description":"Public key for web push notifications
"},"authSecret":{"type":"string","description":"Auth secret for web push notifications
"},"apnsToken":{"type":"string","description":"Apple Push Notification Services token (for iOS Apps or Mac OS Safari)
"},"fcmToken":{"type":"string","description":"Google / Firebase Cloud Messaging token (for Android Apps)
"},"fcmId":{"type":"string","description":"Google / Firebase Cloud Messaging Sender ID (for Android Apps)
"},"emailAddress":{"type":"string","description":"Email address (for Email channels). Can be changed by specifying the uniqueIdentifier field.
Email Opt In Form ID (for Email channels)
"},"emailOptInConfirmationIgnored":{"type":"boolean","description":"Ignore double opt-in for email subscriptions topics - This lets you assign topics directly even if double opt-in is enabled
"},"emailConfirmed":{"type":"boolean","description":"Set to true to directly confirm email contact without having to click the confirmation link in the double-opt-in email
Phone number (for SMS channels)
"},"phoneConfirmed":{"type":"boolean","description":"Set to true to directly confirm phone contact without having to click the confirmation link in the double-opt-in SMS
Object of custom attributes (Object Key = Attribute ID, Object value = Attribute value)
"},"topics":{"items":{"type":"string","description":"Array of Topic IDs
"},"type":"array","description":"Array of Topic IDs
"},"addTopics":{"type":"boolean","description":"Only add specified Topic IDs instead of overriding them
"},"isEditTopics":{"type":"boolean","description":"Email only - Necessary to override Topic IDs instead of only adding them
"},"browserType":{"type":"string","description":"Browser name (Chrome, Firefox, ... or your app's name e.g. CleverPush)
"},"browserVersion":{"type":"string","description":"Browser / Mobile SDK version
"},"appVersion":{"type":"string","description":"Mobile app version
"},"platformName":{"type":"string","description":"OS name (e.g. Windows, iOS, Android, ...)
"},"platformVersion":{"type":"string","description":"OS version
"},"iosLiveActivityId":{"type":"string","description":"Live Activity ID (Only for iOS)
"},"iosLiveActivityToken":{"type":"string","description":"Live Activity Token (Only for iOS)
"},"uniqueIdentifier":{"type":"string","description":"Field to identify existing subscription with. By default, a suitable field will be chosen automatically based on the channel type. Possible values: "customAttributes.user_id", "customAttributes.member_id", "subscriptionId".
"},"updateOnly":{"type":"boolean","description":"If used it will not create new subscription it will only update existing subscription
"}},"type":"object","required":["browserType","browserVersion","appVersion","platformName","platformVersion"]}}}}}},"/subscription/tag":{"post":{"tags":["Subscriptions"],"summary":"TagSubscription","description":"Tag a subscription","parameters":[],"responses":{"201":{"content":{"application/json":{"example":"HTTP/1.1 201 Created\n{\n \"success\": true\n}","schema":{"title":"Success-Response:","type":"object","properties":{"success":{"type":"boolean"}}}}},"description":"Success-Response:"}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"channelId":{"type":"string","description":"The channel ID.
"},"tagId":{"type":"string","description":"The tag ID. Either tagId or tagExternalId is required.
"},"tagExternalId":{"type":"string","description":"The external tag ID. Either tagId or tagExternalId is required.
"},"subscriptionId":{"type":"string","description":"The subscription ID.
"},"subscriptionIds":{"items":{"type":"string","description":"The subscription IDs (max. 1000).
"},"type":"array","description":"The subscription IDs (max. 1000).
"}},"type":"object","required":["channelId"]}}}}}},"/subscription/trigger-product-campaigns":{"post":{"tags":["Subscriptions"],"summary":"TriggerProductCampaigns","description":"Trigger product follow-up campaigns","parameters":[],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"success\": true\n}","schema":{"title":"Success-Response:","type":"object","properties":{"success":{"type":"boolean","description":""}},"required":["success"]}}},"description":"Success-Response:"}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"subscriptionId":{"type":"string","description":"The subscription ID.
"},"channelId":{"type":"string","description":"The Channel ID.
"},"triggerType":{"type":"string","description":"The trigger type.
"},"productId":{"type":"string","description":"The product ID.
"},"parameters":{"type":"object","properties":{},"description":"The event parameters.
"}},"type":"object","required":["subscriptionId","channelId","triggerType","productId","parameters"]}}}}}},"/subscription/unsubscribe":{"post":{"tags":["Subscriptions"],"summary":"UnsubscribeSubscription","description":"Unsubscribe a subscription","parameters":[],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"success\": true\n}","schema":{"title":"Success-Response:","type":"object","properties":{"success":{"type":"boolean"},"id":{"type":"string","description":"The Subscription ID
"}},"required":["id"]}}},"description":"Success-Response:"}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"subscriptionId":{"type":"string","description":"The subscription ID.
"},"channelId":{"type":"string","description":"The channel ID.
"},"optOutSource":{"type":"string","description":"The opt-out source.
"},"markAsUnsubscribed":{"type":"boolean","description":"Set to true to specifically handle email unsubscription (will mark email as blocked instead of removing the subscription).
"},"topics":{"items":{"type":"string","description":"Array of topic IDs to unsubscribe from. And it will be used only if markAsUnsubscribed is true.
Array of topic IDs to unsubscribe from. And it will be used only if markAsUnsubscribed is true.
The channel ID.
"},"tagId":{"type":"string","description":"The tag ID. Either tagId or tagExternalId is required.
"},"tagExternalId":{"type":"string","description":"The external tag ID. Either tagId or tagExternalId is required.
"},"subscriptionId":{"type":"string","description":"The single subscription ID.
"},"subscriptionIds":{"items":{"type":"string","description":"Array of subscription IDs (maximum 1000).
"},"type":"array","description":"Array of subscription IDs (maximum 1000).
"}},"type":"object","required":["channelId"]}}}}}},"/survey/answers/{channelId}/{surveyId}":{"get":{"tags":["Survey"],"summary":"GetSurveyAnswers","description":"Get Survey Answers","parameters":[{"schema":{"type":"string"},"in":"path","name":"channelId","description":"Channel ID","required":true},{"schema":{"type":"string"},"in":"path","name":"surveyId","description":"Survey ID","required":true},{"schema":{"type":"string","default":"50"},"in":"query","name":"limit","description":"Page size (max 200)"},{"schema":{"type":"string","default":"1"},"in":"query","name":"page","description":"Page number (1-based)"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{},"type":"object","required":[]}}}}}}},"/team/{id}/members":{"post":{"tags":["Teams"],"summary":"TeamMemberCreate","description":"Create a team member","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"The team id","required":true}],"responses":{"201":{"content":{"application/json":{"example":"HTTP/1.1 201 OK\n{\n \"user\": { \"_id\": \"XXXXXXXX\", \"profile\": { \"name\": \"John Doe\" }, \"newUser\": true }\n}","schema":{"title":"Success-Response:","type":"object","properties":{"user":{"type":"object","properties":{"_id":{"type":"string"},"profile":{"type":"object","properties":{"name":{"type":"string"}}},"newUser":{"type":"boolean"}}}}}}},"description":"Success-Response:"}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"email":{"type":"string","description":"The team member email
"},"role":{"type":"string","description":"The team member role (default: 'admin')
"},"channels":{"items":{"type":"string","description":"Array of channel IDs the team member has access to (default: all channels in team)
"},"type":"array","description":"Array of channel IDs the team member has access to (default: all channels in team)
"}},"type":"object","required":["email"]}}}}}},"/teams":{"post":{"tags":["Teams"],"summary":"TeamsCreate","description":"Create a team","parameters":[],"responses":{"201":{"content":{"application/json":{"example":"HTTP/1.1 201 OK\n{\n \"team\": { \"_id\": \"XXXXXXXX\" }\n}","schema":{"title":"Success-Response:","type":"object","properties":{"team":{"type":"object","properties":{"_id":{"type":"string"}}}}}}},"description":"Success-Response:"}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"name":{"type":"string","description":"The team name
"},"channels":{"items":{"type":"string","description":"Array of channel IDs the team members have access to (unless overridden in specific member settings)
"},"type":"array","description":"Array of channel IDs the team members have access to (unless overridden in specific member settings)
"}},"type":"object","required":["name","channels"]}}}}}},"/channel/{channelId}/web-banners":{"post":{"tags":["WebBanner"],"summary":"Create_WebBanner","description":"Create WebBanner","parameters":[{"schema":{"type":"string"},"in":"path","name":"channelId","description":"The Channel ID","required":true}],"responses":{"200":{"content":{"application/json":{"example":" HTTP/1.1 200 OK\n{\n \"webBannerId\": \"xxxxxxx34xxxx\",\n \"status\": true\n }","schema":{"title":"Success-Response:","type":"object","properties":{"webBannerId":{"type":"string"},"status":{"type":"boolean"},"String":{"type":"string","description":"containing webBannerId
"},"Boolean":{"type":"boolean","description":"value containing status field
"}},"required":["String","Boolean"]}}},"description":"Success-Response:"}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"name":{"type":"string","description":""},"contentState":{"type":"object","properties":{}},"buttonStyle":{"type":"object","properties":{}},"startsAt":{"type":"string","description":""},"endsAt":{"type":"string","description":""},"timeout":{"type":"number","description":""},"status":{"type":"string","description":""},"matchPath":{"type":"string","description":""},"matchDomain":{"type":"string","description":""},"matchQuery":{"type":"object","properties":{}},"noMatchPath":{"type":"string","description":""},"matchFunction":{"type":"string","description":""},"trafficPercentage":{"type":"number","description":""},"scrollPercentage":{"type":"number","description":""},"showOnlySubscribers":{"type":"boolean","description":""},"customCss":{"type":"string","description":""},"darkenBackground":{"type":"boolean","description":""},"exitIntent":{"type":"boolean","description":""},"exitIntentForMobile":{"type":"boolean","description":""},"enableRegularDisplayForMobile":{"type":"boolean","description":""},"minimumVisits":{"type":"number","description":""},"attributes":{"type":"array","items":{"type":"object","properties":{}}},"oncePerClick":{"type":"boolean","description":""},"frequency":{"type":"string","description":""},"frequencyInterval":{"type":"number","description":""},"tags":{"items":{"type":"string","description":""},"type":"array"},"excludeTags":{"items":{"type":"string","description":""},"type":"array"},"topics":{"items":{"type":"string","description":""},"type":"array"},"excludeTopics":{"items":{"type":"string","description":""},"type":"array"},"topicsLogic":{"type":"string","description":""},"tagsLogic":{"type":"string","description":""}},"type":"object","required":["name","contentState","buttonStyle","startsAt","endsAt","timeout","status","matchPath","matchDomain","matchQuery","noMatchPath","matchFunction","trafficPercentage","scrollPercentage","showOnlySubscribers","customCss","darkenBackground","exitIntent","exitIntentForMobile","enableRegularDisplayForMobile","minimumVisits","attributes","oncePerClick","frequency","frequencyInterval","tags","excludeTags","topics","excludeTopics","topicsLogic","tagsLogic"]}}}}},"get":{"tags":["WebBanner"],"summary":"Get_WebBanners","description":"Get All WebBanners of Channel","parameters":[{"schema":{"type":"string"},"in":"path","name":"channelId","description":"The Channel ID","required":true},{"schema":{"type":"string"},"in":"query","name":"limit","description":"How many WebBanners to get. Default: 10."},{"schema":{"type":"string"},"in":"query","name":"offset","description":"How many WebBanners to skip. Default: 0"}],"responses":{"200":{"content":{"application/json":{"example":" HTTP/1.1 200 OK\n{\n \"webBanners\": [\n {\n \"_id\": \"xxxxxxsdrcxxx\",\n \"channel\": \"xxxxxxx3xxxx\",\n \"name\": \"New Banner\",\n \"contentState\": {\n \"contentWidth\": 600,\n \"bodyStyle\": {\n \"fontSize\": 14\n },\n \"linkStyle\": {\n \"textDecoration\": \"none\"\n },\n \"rows\": [\n {\n \"id\": \"KxCvxbJF\",\n \"colSize\": [\n 12\n ],\n \"cols\": [\n {\n \"id\": \"Dm2HLS86\",\n \"size\": 12,\n \"elements\": [\n {\n \"id\": \"34tqLRQd\",\n \"type\": \"text\",\n \"style\": {\n \"paddingTop\": 15,\n \"paddingRight\": 15,\n \"paddingBottom\": 15,\n \"paddingLeft\": 15\n },\n \"focused\": false,\n \"content\": \"of objects containing webbanners
"}},"required":["Array"]}}},"description":"Success-Response:"}}}},"/channel/{channelId}/web-banners/{webBannerId}":{"delete":{"tags":["WebBanner"],"summary":"DeleteWebBannerById","description":"Delete WebBanner","parameters":[{"schema":{"type":"string"},"in":"path","name":"channelId","description":"The Channel ID","required":true},{"schema":{"type":"string"},"in":"path","name":"webBannerId","description":"The Web Banner ID","required":true}],"responses":{"200":{"content":{"application/json":{"example":" HTTP/1.1 200 OK\n{\n \"success\": true\n }","schema":{"title":"Success-Response:","type":"object","properties":{"success":{"type":"boolean"},"Object":{"type":"object","properties":{},"description":"containing success boolean value
"}},"required":["Object"]}}},"description":"Success-Response:"}}},"get":{"tags":["WebBanner"],"summary":"Get_WebBanner_By_Id","description":"Get WebBanner by Id for particular channel","parameters":[{"schema":{"type":"string"},"in":"path","name":"channelId","description":"The Channel ID","required":true},{"schema":{"type":"string"},"in":"path","name":"webBannerId","description":"The webBanner ID","required":true}],"responses":{"200":{"content":{"application/json":{"example":" HTTP/1.1 200 OK\n{\n \"webBanner\": {\n \"_id\": \"xxxxxxsdrcxxx\",\n \"channel\": \"xxxxxxx3xxxx\",\n \"name\": \"New Banner\",\n \"contentState\": {\n \"contentWidth\": 600,\n \"bodyStyle\": {\n \"fontSize\": 14\n },\n \"linkStyle\": {\n \"textDecoration\": \"none\"\n },\n \"rows\": [\n {\n \"id\": \"KxCvxbJF\",\n \"colSize\": [\n 12\n ],\n \"cols\": [\n {\n \"id\": \"Dm2HLS86\",\n \"size\": 12,\n \"elements\": [\n {\n \"id\": \"34tqLRQd\",\n \"type\": \"text\",\n \"style\": {\n \"paddingTop\": 15,\n \"paddingRight\": 15,\n \"paddingBottom\": 15,\n \"paddingLeft\": 15\n },\n \"focused\": false,\n \"content\": \"containing the WebBanner for given webBannerId
"}},"required":["Object"]}}},"description":"Success-Response:"}}},"post":{"tags":["WebBanner"],"summary":"Update_WebBanner_By_ID","description":"Update WebBanner","parameters":[{"schema":{"type":"string"},"in":"path","name":"channelId","description":"The Channel ID","required":true},{"schema":{"type":"string"},"in":"path","name":"webBannerId","description":"The Web Banner ID","required":true}],"responses":{"200":{"content":{"application/json":{"example":" HTTP/1.1 200 OK\n{\n \"updatedBanner\": {\n \"attributes\": [\n {\n \"id\": \"13\",\n \"value\": \"value of 13 id\"\n },\n {\n \"id\": \"14\",\n \"value\": \"value of 14 id\"\n },\n {\n \"id\": \"15\",\n \"value\": \"value of 15 id\"\n }\n ],\n \"updatedAt\": \"2022-10-05T05:21:57.088Z\"\n },\n \"status\": true\n }","schema":{"title":"Success-Response:","type":"object","properties":{"updatedBanner":{"type":"object","properties":{"attributes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["id","value"]}},"updatedAt":{"type":"string"}}},"status":{"type":"boolean"},"Object":{"type":"object","properties":{},"description":"containing updated values and updatedAt field
"},"Boolean":{"type":"boolean","description":"value containing status field
"}},"required":["Object","Boolean"]}}},"description":"Success-Response:"}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"Object":{"type":"object","properties":{},"description":"containing the values which is to be updated
"}},"type":"object","required":["Object"]}}}}}},"/channel/{channelId}/web-banners/{id}/statistics":{"get":{"tags":["WebBanner"],"summary":"GetWebBannerStatistics","description":"Get Web Banner Statistics","parameters":[{"schema":{"type":"string"},"in":"path","name":"channelId","description":"The id of the channel","required":true},{"schema":{"type":"string"},"in":"path","name":"id","description":"The id of the web banner","required":true},{"schema":{"type":"string"},"in":"query","name":"startDate","description":"The start date of the statistics","required":true},{"schema":{"type":"string"},"in":"query","name":"endDate","description":"The end date of the statistics (max 90 days)","required":true}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"statistics\": [\n {\n \"date\": \"2024-01-01T00:00:00.000Z\",\n \"totalClicked\": 10,\n \"totalDelivered\": 20,\n \"totalClosed\": 1,\n \"totalBounces\": 2,\n \"totalConversions\": 3\n },\n {\n \"date\": \"2024-01-02T00:00:00.000Z\",\n \"totalClicked\": 15,\n \"totalDelivered\": 25,\n \"totalClosed\": 1,\n \"totalBounces\": 2,\n \"totalConversions\": 3\n }\n ],\n \"metadata\": {\n \"query\": {\n \"startDate\": \"2024-01-01T00:00:00.000Z\",\n \"endDate\": \"2024-01-02T23:59:59.999Z\"\n }\n }\n}","schema":{"title":"Success-Response:","type":"object","properties":{"statistics":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string"},"totalClicked":{"type":"number"},"totalDelivered":{"type":"number"},"totalClosed":{"type":"number"},"totalBounces":{"type":"number"},"totalConversions":{"type":"number"}},"required":["date","totalClicked","totalDelivered","totalClosed","totalBounces","totalConversions"]},"description":"The statistics of the web banner
"},"metadata":{"type":"object","properties":{"query":{"type":"object","properties":{"startDate":{"type":"string"},"endDate":{"type":"string"}}}}}},"required":["statistics"]}}},"description":"Success-Response:"}}}},"/channel/{id}/whatsapp-templates":{"get":{"tags":["Whatsapp"],"summary":"GetWhatsAppTemplates","description":"Get WhatsApp templates","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","description":"The channel ID","required":true},{"schema":{"type":"string"},"in":"query","name":"offset","description":"How many templates to skip. Default: 0"},{"schema":{"type":"string"},"in":"query","name":"limit","description":"How many templates to get. Default: 25"}],"responses":{"200":{"content":{"application/json":{"example":"HTTP/1.1 200 OK\n{\n \"templates\": [\n {\n \"category\": \"MARKETING\",\n \"components\": [\n {\n \"example\": {\n \"body_text\": [\n \"get quotes\",\n \"business query\",\n \"normal optioon\"\n ]\n },\n \"text\": \"What do you want to do now? {{1}} {{2}} {{3}}\",\n \"type\": \"BODY\"\n },\n {\n \"example\": {\n \"header_handle\": [\n \"https://images.unsplash.com/photo-1641584495089-5914d85d9bcc?ixlib=rb-1.2.1&ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&auto=format&fit=crop&w=1170&q=80\"\n ]\n },\n \"format\": \"IMAGE\",\n \"type\": \"HEADER\"\n },\n {\n \"text\": \"your-footer-text\",\n \"type\": \"FOOTER\"\n },\n {\n \"buttons\": [\n {\n \"phone_number\": \"+1(650) 555-1111\",\n \"text\": \"your-phone-button-text\",\n \"type\": \"PHONE_NUMBER\"\n },\n {\n \"example\": [\n \"de/blog/dynamic-url-example\"\n ],\n \"text\": \"your-url-button-text\",\n \"type\": \"URL\",\n \"url\": \"https://www.website.com/{{1}}\"\n }\n ],\n \"type\": \"BUTTONS\"\n }\n ],\n \"language\": \"en_US\",\n \"name\": \"template_name_example\",\n \"namespace\": \"54************af5\",\n \"rejected_reason\": \"\",\n \"status\": \"approved\"\n }\n ],\n \"count\": 1\n}","schema":{"title":"Success-Response:","type":"object","properties":{"templates":{"type":"array","items":{"type":"object","properties":{"category":{"type":"string"},"components":{"type":"array","items":{"type":"object","properties":{"example":{"type":"object","properties":{"body_text":{"type":"array","items":{"type":"string"}},"header_handle":{"type":"array","items":{"type":"string"}}}},"text":{"type":"string"},"type":{"type":"string"},"format":{"type":"string"},"buttons":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string"},"text":{"type":"string"},"type":{"type":"string"},"example":{"type":"array","items":{"type":"string"}},"url":{"type":"string"}},"required":["text","type"]}}},"required":["example","type","text"]}},"language":{"type":"string"},"name":{"type":"string"},"namespace":{"type":"string"},"rejected_reason":{"type":"string"},"status":{"type":"string"}}},"description":"WhatsApp Templates
"},"count":{"type":"number"}},"required":["templates"]}}},"description":"Success-Response:"}}}}}}