Update Subscription Details

This API allows you to update SMS/email subscription details of a customer.

API Endpoint Example

curl --location 'https://eu.api.capillarytech.com/v2/customers/565039505/subscriptions?format=json' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'Authorization: Basic dGpfY2FwaWxsYXJ5OjVjMTc3MDJlOTI5NjQ4MjUzZTY3ZDJiMGM2ZTk5ZjE5' \
--header 'Cookie: _cfuvid=ELP_n3u8qC1Vt2z0yryFjifRT6N.CVONHAt3Fse0zsQ-1750659660819-0.0.1.1-604800000; _cfuvid=Xlu0xR4rWHodl7BXGQjSJ88NKmFp2TybTHNUzeYcwfs-1750676916066-0.0.1.1-604800000' \
--data '
{
  "communicationId": -1,
  "campaignId": -1,
  "reason": "This is V2 subscription api",
  "scope": {
    "scope": "USER",
    "subScope": "NONE"
  },
  "subscriptions": [
    {
      "channel": "EMAIL",
      "priority": "BULK",
      "type": "OPTOUT",
      "orgUnitId": 200031782,
      "sourceName": "FACEBOOK",
      "accountId": "01"
    },
    {
      "channel": "MOBILE",
      "accountId": "01",
      "priority": "BULK",
      "type": "OPTIN",
      "orgUnitId": 200031782,
      "sourceName": "FACEBOOK"
    },
    {
      "channel": "EMAIL",
      "accountId": "01",
      "priority": "TRANS",
      "type": "OPTIN",
      "orgUnitId": 200031782,
      "sourceName": "FACEBOOK"
    },
    {
      "channel": "MOBILE",
      "accountId": "01",
      "priority": "TANS",
      "type": "OPTOUT",
      "orgUnitId": 200031782,
      "sourceName": "FACEBOOK"
    }
  ]
}
'

Prerequisites

  • Basic Authentication
  • Default access group

Resource information

URIv1.1/points/isredeemable?
HTTP methodGET
AuthenticationBasic
Pagination supported?No
Rate limitYes
Batch supportNo

Request Body Parameters

ParameterDatatypeDescription
mobile/email/external_id/id*stringProvide any of the customer identifiers to update subscription details.
priority*enumSpecify the service that you want to update. Value: TRANS for personalised messages, and BULK for campaign or promotional messages.
scopeenumSet the scope to 'all' always.
channel*enumPass the communication channel that you want to update. Value: sms, email.
is_subscribed*enumSpecify 0 to unsubscribe, 1 to subscribe.
Language
Credentials
Basic
base64
:
URL
Click Try It! to start a request and see the response here!