Purpose
The mysubscriptionsset API is used to set subscriptions to kB articles, mailing list, and campaigns.
UI Reference: The API is called when subscribing to KB articles, or adding a contact to a mailing list or campaign.
URI: webapp-api-findanswer?api=mysubscriptionsset
Access Rights Required:
Request
Request Parameters
Name |
Type |
Description |
|---|---|---|
subscriptions |
Object |
|
subscriptions[].listIDs |
Array |
|
subscriptions[].campaignIDs |
Array |
|
subscriptions[].articleIDs |
Array |
|
__TZO__ |
String |
|
_pageAction |
String |
This parameter represents the action name which is performed from the page. |
Request Payload Example
{ "subscriptions": { "listIDs": [], "campaignIDs": [], "articleIDs": [] }, "__TZO__": "-08:00", "_pageAction": "FindAnswerMySubscriptionsSet" } |
Response
Response Parameters
Name |
Type |
Description |
|---|---|---|
errors |
Array |
An array of strings. Returns the error message if an error is encountered, otherwise a blank array if there is no error. |
errorDetails |
Array |
An array of strings. Provides detailed information about the error encountered, otherwise returns a blank array if no error is encountered. |
lists |
Array |
|
lists[].id |
String |
|
lists[].name |
String |
|
lists[].description |
String |
|
lists[].isOnList |
Boolean |
|
campaigns |
Array |
|
campaigns[].id |
String |
|
campaigns[].name |
String |
|
campaigns[].description |
String |
|
campaigns[].isOnList |
Boolean |
|
articles |
Array |
Response Example
{ "errors": [], "errorDetails": [], "lists": [ { "id": "6", "name": "Online Specials", "description": "Receive notices about online specials.", "isOnList": false } ], "campaigns": [ { "id": "campaign-1", "name": "Photography tips and trick", "description": "Ongoing tips for getting the most out of your new camera.", "isOnList": false } ], "articles": [] } |
