v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get Subscription Details

Retrieves SMS and email subscription details of a customer. You can filter the results by priority and communication channel. To retrieve subscription details of multiple customers, pass each customer identifier separating by comma.

get/customer/subscriptions

Query parameters

format'json' | 'xml'

mobilestring

Mobile number of the customer.

emailstring

Email ID of the customer.

external_idstring

External ID of the customer.

idinteger

Unique ID of the customer.

Filter results by communication channel.

limitinteger

Limit the number of results to retrieve. For example, limit=4 fetches only four recommendations.

priority'TRANS' | 'BULK'

Filter the results by message type.

scope'ALL'

Pass ALL to retrieve the details of all subscription modules. For example, points, coupons, general etc.

Response

200

Example response

{
  "response": {
    "status": {
      "success": "true",
      "code": 200,
      "message": "Success"
    },
    "subscriptions": {
      "subscription": [
        {
          "user_id": "29372667",
          "mobile": "447700900000",
          "email": "tom.sawyer@example.com",
          "external_id": "XYPZ001",
          "channel": [
            {
              "name": "SMS",
              "priority": [
                {
                  "name": "TRANS",
                  "subscribed": "ALL",
                  "user_preference": "SUBSCRIBED"
                }
              ]
            }
          ],
          "item_status": {
            "code": "1000",
            "message": "Subscription successfully retrieved",
            "success": "true"
          }
        }
      ]
    }
  }
}