PATCH

/v1/subscribers/{subscriberId}/preferences/{templateId}

Authorization*
curl --request PATCH \
  --url https://api.novu.co/v1/subscribers/{subscriberId}/preferences/{templateId} \
  --header 'Authorization: ApiKey' \
  --header 'Content-Type: application/json'
{
  "data": {
    "preference": {
      "channels": {
        "chat": "boolean",
        "email": "boolean",
        "in_app": "boolean",
        "push": "boolean",
        "sms": "boolean"
      },
      "enabled": "boolean"
    },
    "template": {
      "_id": "string",
      "critical": "boolean",
      "name": "string"
    }
  }
}

Please ensure there is a space between ApiKey and your Api key.

E.g ApiKey 18d2e625f05d80e

Path Parameters

subscriberIdrequired
string
templateIdrequired
string

Body

application/json
channel
object

The subscriber preferences for every ChannelTypeEnum for the workflow assigned.

enabled
boolean

Sets if the workflow is fully enabled for all channels or not for the subscriber.

Response

200 - application/json
data
object