v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Update Subscription Details

post/customers/{userId}/subscriptions

Path parameters

userIdinteger required

Unique ID of the customer to add or update subscription details.

Headers

X-CAP-API-OAUTH-TOKENstring

Request body

RAW_BODYstring json

Response

200

campaignIdinteger

communicationIdinteger

reasonstring

Example response

{
  "scope": {
    "scope": "USER",
    "subScope": "NONE",
    "setScope": true,
    "setSubScope": true
  },
  "subscriptions": [
    {
      "channel": "EMAIL",
      "priority": "BULK",
      "type": "OPTOUT"
    }
  ],
  "campaignId": -1,
  "communicationId": -1,
  "reason": "Sample reason"
}