GET
/
v1
/
subscribers
/
{subscriberId}
/
preferences
/
{parameter}
curl --request GET \
  --url https://api.novu.co/v1/subscribers/{subscriberId}/preferences/{parameter} \
  --header 'Authorization: <api-key>'
{
  "data": [
    {
      "template": {
        "_id": "<string>",
        "name": "<string>",
        "critical": true,
        "triggers": [
          "<string>"
        ]
      },
      "preference": {
        "enabled": true,
        "channels": {
          "email": true,
          "sms": true,
          "in_app": true,
          "chat": true,
          "push": true
        }
      }
    }
  ]
}

Enter your API key in the Authorization field like the example shown below:

E.g ApiKey 18d2e625f05d80e

Authorizations

Authorization
string
headerrequired

API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".

Path Parameters

parameter
enum<string>
required

Fetch global or per workflow channel preferences

Available options:
global,
template
subscriberId
string
required

Query Parameters

includeInactiveChannels
boolean

A flag which specifies if the inactive workflow channels should be included in the retrieved preferences. Default is true

Response

200 - application/json
data
object[]

Was this page helpful?

Get subscriber preferencesUpdate subscriber preference