Skip to main content

GlobalPreferences

Subscriber's global (all-workflow) notification preferences.

Usage profiles​

UsageFields and validation
In responsesView fields

In responses​

API JSON uses JSON field names (camelCase).

FieldTypePresenceMeaning
enabledbooleanOptionalMaster switch — false disables all non-critical notifications.
channelsChannelTogglesOptionalChannel switches recorded for these subscriber preferences.

Where used​

ReferenceRelationship
Get notification preferencesPOST /api/v1/notifications/get-preferences
Get the caller's subscriber profilePOST /api/v1/notifications/manage/get-subscriber

Download the public reference contract.

Document: DOC-API-MODEL-global-preferences.