Skip to main content
PATCH
TypeScript

Authorizations

Authorization
string
header
required

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

Headers

idempotency-key
string

A header for idempotency purposes

Path Parameters

subscriberId
string
required

The identifier of the subscriber

Body

application/json
preferences
object[]
required

Array of workflow preferences to update (maximum 100 items)

Maximum array length: 100
context
object

Response

OK

level
enum<string>
required

The level of the preference (global or template)

Available options:
global,
template
enabled
boolean
required

Whether the preference is enabled

Example:

true

channels
object
required

Channel-specific preference settings

workflow
object | null

Workflow information if this is a template-level preference

condition
object | null

Condition using JSON Logic rules