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
channels
object

Channel-specific preference settings

workflowId
string

Workflow internal _id, identifier or slug. If provided, update workflow specific preferences, otherwise update global preferences

schedule
object

Subscriber schedule

context
object

Response

OK

global
object
required

Global preference settings

workflows
object[]
required

Workflow-specific preference settings