Update subscriber global or workflow specific preferences

PATCH/v2/subscribers/{subscriberId}/preferences

Authorization

Authorization<token>

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

In: header

Request Body

application/jsonRequired

channelsRequiredobject

Channel-specific preference settings

workflowIdstring

If provided, update workflow specific preferences, otherwise update global preferences

Path Parameters

subscriberIdRequiredstring

Header Parameters

idempotency-keystring

A header for idempotency purposes

curl -X PATCH "https://api.novu.co/v2/subscribers/<string>/preferences" \
  -H "idempotency-key: <string>" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "channels": {
      "email": true,
      "sms": true,
      "in_app": true,
      "push": true,
      "chat": true
    },
    "workflowId": "string"
  }'

{
  "global": {
    "enabled": true,
    "channels": {
      "email": true,
      "sms": true,
      "in_app": true,
      "chat": true,
      "push": true
    }
  },
  "workflows": [
    {
      "enabled": true,
      "channels": {
        "email": true,
        "sms": true,
        "in_app": true,
        "chat": true,
        "push": true
      },
      "overrides": [
        {
          "channel": "in_app",
          "source": "subscriber"
        }
      ],
      "workflow": {
        "slug": "string",
        "identifier": "string",
        "name": "string"
      }
    }
  ]
}

Update subscriber global or workflow specific preferences

Authorization

Request Body

Path Parameters

Header Parameters

Response

TypeScript