WorkflowPreferences
Per-workflow notification channel preferences for a subscriber.
Usage profiles
| Usage | Fields and validation |
|---|---|
| In responses | View fields |
In responses
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
workflowId | string | Optional | Novu workflow identifier (slug). |
workflowName | string | Optional | Human-readable display name. |
critical | boolean | Optional | If true, subscriber cannot opt out (admin-enforced). |
tags | Array of string | Optional | Workflow tags for grouping in settings UI. |
channels | ChannelToggles | Optional | Channel switches recorded for these subscriber preferences. |
Where used
| Reference | Relationship |
|---|---|
| Get notification preferences | POST /api/v1/notifications/get-preferences |
| Get the caller's subscriber profile | POST /api/v1/notifications/manage/get-subscriber |
Download the public reference contract.
Document: DOC-API-MODEL-workflow-preferences.