Update subscriber preferences
Update subscriber preferences by its unique key identifier **subscriberId**. **workflowId** is optional field, if provided, this API will update that workflow preference, otherwise it will update global preferences
Update subscriber preferences by its unique key identifier subscriberId. workflowId is optional field, if provided, this API will update that workflow preference, otherwise it will update global preferences
Authorization
Authorization<token>API key authentication. Allowed headers-- "Authorization: ApiKey <novu_secret_key>".
In: header
Request Body
application/jsonRequiredchannelsobjectChannel-specific preference settings
workflowIdstringWorkflow internal _id, identifier or slug. If provided, update workflow specific preferences, otherwise update global preferences
scheduleobjectSubscriber schedule
contextobjectPath Parameters
subscriberIdRequiredstringHeader Parameters
idempotency-keystringA header for idempotency purposes
Response Body
OK
globalRequiredobjectGlobal preference settings
workflowsRequiredarray<object>Workflow-specific preference settings
Retrieve subscriber preferences GET
Retrieve subscriber channel preferences by its unique key identifier **subscriberId**. This API returns all five channels preferences for all workflows and global preferences.
Bulk update subscriber preferences PATCH
Bulk update subscriber preferences by its unique key identifier **subscriberId**. This API allows updating multiple workflow preferences in a single request.