ChannelToggles
Per-channel notification toggles. All fields are optional so that callers can patch only the channels they want to change (omitted = leave unchanged).
Usage profiles
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
| In responses | View fields |
In requests
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
inApp | boolean | Optional; explicit presence | Whether in-app notification delivery is enabled. |
push | boolean | Optional; explicit presence | Whether push notification delivery is enabled. |
email | boolean | Optional; explicit presence | Whether email notification delivery is enabled. |
sms | boolean | Optional; explicit presence | Whether SMS notification delivery is enabled. |
chat | boolean | Optional; explicit presence | Whether chat notification delivery is enabled. |
In responses
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
inApp | boolean | Optional; explicit presence | Whether in-app notification delivery is enabled. |
push | boolean | Optional; explicit presence | Whether push notification delivery is enabled. |
email | boolean | Optional; explicit presence | Whether email notification delivery is enabled. |
sms | boolean | Optional; explicit presence | Whether SMS notification delivery is enabled. |
chat | boolean | Optional; explicit presence | Whether chat notification delivery is enabled. |
Where used
| Reference | Relationship |
|---|---|
| Bulk-update per-workflow preferences | POST /api/v1/notifications/bulk-update-preferences |
| Update global notification preferences | POST /api/v1/notifications/update-global-preference |
| Update per-workflow notification preferences | POST /api/v1/notifications/update-workflow-preference |
| Get notification preferences | POST /api/v1/notifications/get-preferences |
| Get the caller's subscriber profile | POST /api/v1/notifications/manage/get-subscriber |
| GlobalPreferences | Nested in model |
| UpdateWorkflowPreferenceRequest | Nested in model |
| WorkflowPreferences | Nested in model |
Download the public reference contract.
Document: DOC-API-MODEL-channel-toggles.