GET
/
v1
/
object
/
{object_type}
/
{id}
/
preference
/
category
curl --request GET \
  --url https://hub.suprsend.com/v1/object/{object_type}/{id}/preference/category/ \
  --header 'Authorization: Bearer <token>'
{
  "meta": {
    "count": 12,
    "limit": 10,
    "offset": 0
  },
  "results": [
    {
      "name": "Newsletter",
      "category": "newsletter",
      "description": "Send me updates on new product updates",
      "original_preference": null,
      "preference": "opt_in",
      "is_editable": false,
      "channels": [
        {
          "channel": "email",
          "preference": "opt_in",
          "is_editable": false
        },
        {
          "channel": "ms_teams",
          "preference": "opt_in",
          "is_editable": false
        }
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
object_type
string
required

Used to group similar objects together. Give plural namespace like teams, organizations, and roles.

​
id
string
required

Unique identifier of the object in your system

Query Parameters

​
tenant_id
string

to fetch object preferences for a particular tenant

​
show_opt_out_channels
boolean
default:true

set this flag to true if you want to fetch channel list for opt-out categories.

Response

200
application/json
200
​
meta
object
​
results
object[]

Was this page helpful?