PATCH
/
v1
/
subscribers
/
{subscriberId}
/
preferences
curl --request PATCH \
  --url https://api.novu.co/v1/subscribers/{subscriberId}/preferences \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "enabled": true,
  "preferences": [
    {
      "type": "in_app",
      "enabled": true
    }
  ]
}'
{
  "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

subscriberId
string
required

Body

application/json
enabled
boolean

Enable or disable the subscriber global preferences.

preferences
object[]

The subscriber global preferences for every ChannelTypeEnum.

Response

200 - application/json
data
object

Was this page helpful?

Update subscriber preferenceGet in-app notifications feed of subscriber.