Using API to Update Customer Opt-In or Opt-Out Preferences

Ushur provides APIs for enterprises to update their customers' opt-in preferences when the opt-in choices are made outside of Ushur. For example, the customer can make that choice while on a call with an agent, or on a webpage that allows them to sign up for SMS alerts.

Among other features, the two important APIs relevant for opt-in and opt-out are listed below.

Updating Customer Opt-Out Preference API

{URL}/infoSet/blackListPhone

Request Body:

{

"userPhoneNo":"<phone no>",

"tokenId":"<tokenId>",

"acctUserName":"<username>",

"acctUserFullName":"<name>",

"apiVer":"3.1"

}

Response:

{

"status": "success",

"gbSuccess": true,

"blackListed": true, ("AlreadyBlackListed": true),

"userPhoneNo": "<phone no>"

}

Sample Request:

URL: https://community.ushur.me/infoSet/blackListPhone

Content-Type: application/json

{

"userPhoneNo":"+12345678900",

"tokenId":"<token>",

"acctUserName":"[email protected]",

"acctUserFullName":"Account Owner",

"apiVer":"3.1"

}

Updating Customer Opt-In Preference

{URL}/infoSet/removePhoneFromBlackList

Request Body:

{

"userPhoneNo":"<phone no>",

"tokenId":"<tokenId>",

"acctUserName":"<username>",

"acctUserFullName":"<name>",

"apiVer":"3.1"

}

Response:

{

"status": "success",

"gbSuccess": true,

"blackListed": true, ("AlreadyBlackListed": true),

"userPhoneNo": "<phone no>"

}

Sample Request:

URL: https://community.ushur.me/infoSet/removePhoneFromBlackList

Content-Type: application/json

{

"userPhoneNo":"+12345678900",

"tokenId":"<token>",

"acctUserName":"[email protected] ",

"acctUserFullName":"Account Owner ",

"apiVer":"3.1"

}