Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get Subscription Details

Retrieves the subscription details of a customer to different channels - SMS, email and WeChat. The status will be OPTIN for subscribed and OPTOUT for unsubscribed.

get/customers/lookup/subscriptions

Query parameters

source'FACEBOOK' | 'WEB_ENGAGE' | 'WECHAT' | 'INSTORE' | 'MARTJACK' | 'TMALL' | 'TAOBAO' | 'JD' | 'ECOMMERCE' | 'WEBSITE' | 'LINE' | 'MOBILE_APP' required

Source on which the customer identifier is available.

accountIdstring

Account in which you want to update the customer details (Required only for sources with multiple accounts)

identifierName'mobile' | 'email' | 'externalId' | 'cardExternalId' | 'cardNumber' required

Identifier type to used for the customer

identifierValuestring required

Value of the respective identifier. For example if identifierName is email, then the identifierValue needs to be the email ID of the customer.

Headers

X-CAP-API-OAUTH-TOKENstring

Response

200

campaignIdinteger
communicationIdinteger

Example response

{
  "subscriptions": [
    {
      "channel": "EMAIL",
      "priority": "TRANS",
      "type": "OPTIN"
    }
  ]
}