Section ID:
DOC-API-MODEL-schema-p20l2ff92r#overview
GlobalPreferences
Subscriber's global (all-workflow) notification preferences.
Meaning and usage
Section ID: DOC-API-MODEL-schema-p20l2ff92r#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-p20l2ff92r#fields
| Usage | Fields and validation |
|---|---|
| In responses | View fields |
In responses
Section ID: DOC-API-MODEL-schema-p20l2ff92r#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-p20l2ff92r#field-enabledSection ID: DOC-API-MODEL-schema-p20l2ff92r#response-field-enabledenabled | boolean | Optional | Master switch — false disables all non-critical notifications. |
Section ID: DOC-API-MODEL-schema-p20l2ff92r#field-channelsSection ID: DOC-API-MODEL-schema-p20l2ff92r#response-field-channelschannels | ChannelToggles | Optional | Channel switches recorded for these subscriber preferences. |
Where used
Section ID: DOC-API-MODEL-schema-p20l2ff92r#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 ID: DOC-API-MODEL-schema-p20l2ff92r