Get subscriber preferences by level

GET

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

the preferences level to be retrieved (template / global)

Available options:

global,

template

subscriberId

string

required

Response

200 - application/json

data

object[]

Was this page helpful?

Get subscriber preferences Update subscriber preference

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
        }
      }
    }
  ]
}