Purpose
The subscriptions API is used to provides a contact's subscriptions to mailing lists, campaigns, and knowledge base articles on the Contact Subscriptions data.
UI Reference: The API is called when the Subscriptions tab is opened.
URI: webapp-api-custinfo?api=subscriptions.
Access Rights Required: All users, but customers only receive values for their own contact ID.
Request
The contact ID is the only value passed for this endpoint.
Request Parameters
Name |
Type |
Description |
|---|---|---|
contactID |
Number |
This parameter represents the ID of the contact. |
Request Payload Example
{ |
Response
The response provides details on all the mailing lists, campaigns, and knowledge base articles to which the contact is subscribed.
Response Parameters
Name |
Type |
Description |
|---|---|---|
subscriptions |
Object |
An object that contains all of the subscription data. |
lists |
Array |
An array of strings. These are the mailing lists available for the contact, based on the agent's segment access. |
lists[].listID |
String |
ID of the mailing list. |
lists[].name |
String |
Name of the mailing list. |
lists[].description |
String |
Description of the mailing list. |
lists[].isShownMyAccount |
Boolean |
Indicates whether the mailing list is shown to customers in the customer portal. |
lists[].isOnList |
Boolean |
Indicates whether the contact is a member of the mailing list. |
lists[].isOptedOut |
Boolean |
Indicates whether the contact has opted out of the mailing list. |
campaigns |
Array |
An array of strings. These are the mailing cammpaigns available for the contact, based on the agent's segment access. |
campaigns[].campaignID |
String |
ID of the mailing campaign. |
campaigns[].name |
String |
Name of the mailing campaign. |
campaigns[].description |
String |
Description of the mailing campaign. |
campaigns[].isShownMyAccount |
Boolean |
Indicates whether the campaign is shown to customers in the customer portal. |
campaigns[].isOnList |
Boolean |
Indicates whether the contact is a member of the mailing campaign. |
campaigns[].OptedOut |
Boolean |
Indicates whether the contact has opted out of the mailing campaign. |
articles |
Array |
An array of strings. These are the knowledgbase articles to which the contact has subscribed. It will be empty if the contact has not subscribed to any articles. |
articles[].articleID |
String |
The ID of the article. |
articles[].topicName |
String |
The name of the topic associated with the article. This includes the full path name, including the parent topics. |
articles[].subject |
String |
The subject of the article. |
Response Example
{ "subscriptions": { "lists": [ { "listID": "3", "name": "Customer News", "description": "Important news items for current customers.", "isShownMyAccount": true, "isOnList": true, "isOptedOut": false }, { "listID": "1", "name": "eShop Customers Announcements", "description": "General announcements for eShop customers.", "isShownMyAccount": true, "isOnList": true, "isOptedOut": false }, { "listID": "10", "name": "Monthly Coupons", "description": "Receive a monthly coupon for 5-15% off of your total order.", "isShownMyAccount": true, "isOnList": true, "isOptedOut": false }, { "listID": "6", "name": "Online Specials", "description": "Receive notices about online specials.", "isShownMyAccount": true, "isOnList": true, "isOptedOut": false }, { "listID": "2", "name": "Platinum Customers", "description": "Our best customers", "isShownMyAccount": false, "isOnList": true, "isOptedOut": false } ], "campaigns": [ { "campaignID": "3", "name": "New Customer", "description": "New customer sign on", "isShownMyAccount": false, "isOnList": false, "isOptedOut": false }, { "campaignID": "1", "name": "Photography tips and trick", "description": "Ongoing tips for getting the most out of your new camera.", "isShownMyAccount": true, "isOnList": true, "isOptedOut": false }, { "campaignID": "2", "name": "Upsell campaign", "description": "Upsell reminder", "isShownMyAccount": false, "isOnList": false, "isOptedOut": false } ], "articles": [ { "articleID": "91", "topicName": "e-shop -- All Topics -- Products -- Televisions", "subject": "Are there ENERGY STAR qualified televisions?" } ] } } |
