Section ID: DOC-API-MODEL-schema-p2jctrvcjc#overview

WorkflowPreferences

Per-workflow notification channel preferences for a subscriber.

Meaning and usage

Section ID: DOC-API-MODEL-schema-p2jctrvcjc#meaning

See the definition above.

Usage profiles

Section ID: DOC-API-MODEL-schema-p2jctrvcjc#fields

Usage	Fields and validation
In responses	View fields

In responses

Section ID: DOC-API-MODEL-schema-p2jctrvcjc#response

API JSON uses JSON field names (camelCase).

Field	Type	Presence	Meaning
Section ID: DOC-API-MODEL-schema-p2jctrvcjc#field-workflowidSection ID: DOC-API-MODEL-schema-p2jctrvcjc#response-field-workflowidworkflowId	string	Optional	Novu workflow identifier (slug).
Section ID: DOC-API-MODEL-schema-p2jctrvcjc#field-workflownameSection ID: DOC-API-MODEL-schema-p2jctrvcjc#response-field-workflownameworkflowName	string	Optional	Human-readable display name.
Section ID: DOC-API-MODEL-schema-p2jctrvcjc#field-criticalSection ID: DOC-API-MODEL-schema-p2jctrvcjc#response-field-criticalcritical	boolean	Optional	If true, subscriber cannot opt out (admin-enforced).
Section ID: DOC-API-MODEL-schema-p2jctrvcjc#field-tagsSection ID: DOC-API-MODEL-schema-p2jctrvcjc#response-field-tagstags	Array of string	Optional	Workflow tags for grouping in settings UI.
Section ID: DOC-API-MODEL-schema-p2jctrvcjc#field-channelsSection ID: DOC-API-MODEL-schema-p2jctrvcjc#response-field-channelschannels	ChannelToggles	Optional	Channel switches recorded for these subscriber preferences.

Where used

Section ID: DOC-API-MODEL-schema-p2jctrvcjc#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.

• notifications OpenAPI

Document ID: DOC-API-MODEL-schema-p2jctrvcjc