PATCH
/
v1
/
bulk
/
subscriber
/
preference
curl --request PATCH \
  --url https://hub.suprsend.com/v1/bulk/subscriber/preference/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "distinct_ids": [
    "id1",
    "id2"
  ],
  "channel_preferences": [
    {
      "channel": "email",
      "is_restricted": false
    }
  ],
  "categories": [
    {
      "category": "_category_slug_",
      "preference": "opt_in",
      "opt_out_channels": []
    }
  ]
}'
{
  "success": true
}

Authorizations

​
Authorization
string
header
required

Pass as Bearer <API_KEY>. Get API Key from SuprSend dashboard Developers -> API Keys section.

Query Parameters

​
tenant_id
string

to fetch user preferences for a particular tenant

Body

application/json
​
distinct_ids
string[]
required

distinct_id of users whose preference need to be updated

​
channel_preferences
object[]

Use this to update channel level user preferences. Set is_restricted - true if the channel is opted_out by the user. This will only send critical notifications to the user which can't be opted out

​
categories
object[]

Use this to user preference across categories and channels inside a category.

Response

202
application/json
202
​
success
boolean
Example:

true

Was this page helpful?

Suggest editsRaise issue