...
Editors should be able to select lists or segments from the UM in order to select the target audience for a newsletter or even for a single section within a newsletter.
How to achieve it
Info |
---|
To be able to use this function the CMS must have the following capabilities: Simple integrationThe CMS must be able to create custom content (multi-)select or checkbox fields which can read the option list from a remote REST interface. Advanced integrationThe CMS must be able to create custom fields which can read, select and store structured objects from a remote REST interface. |
...
Universal Messenger ChannelList REST interface
Request
URL: <um-rest-url>/de.pinuts.cmsbs.restapi.Channels/index
Parameters:
umopen: API Key
(optional) semtag: Tenant semtag string as a filter
Response
Format: JSON
Body: Array of channel objects with the following attributes:
id: internal name, this must be used as a value for both <destination> of personalization filter
title: can be used as a label for the editors
isPublic: is a public channel (might not be relevant but can be used as a filter for the editors)
isVChannel: indicated whether objects represents a segment (VCHannel) or a list (Channel), this determines which syntax must be used (see below)
oid: internal ID, if the CMS implementation needs an ID for the stored object this attribute can be used
estimatedCount: contains an estimation of the the number of members (recipients)
Example response
Codeblock |
---|
[{
"id": "demo",
"title": "Demo",
"isPublic": false,
"isVChannel": false,
"oid": "2333888",
"estimatedCount": 435
}, {
"id": "sales",
"title": "Sales employees",
"isPublic": false,
"isVChannel": false,
"oid": "2333883",
"estimatedCount": 23021
}] |