Section ID:
DOC-API-MODEL-schema-oj4cvo85fs#overview
ChannelToggles
Per-channel notification toggles. All fields are optional so callers can patch only the channels they want to change; omitted fields remain unchanged.
Meaning and usage
Section ID: DOC-API-MODEL-schema-oj4cvo85fs#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-oj4cvo85fs#fields
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
| In responses | View fields |
In requests
Section ID: DOC-API-MODEL-schema-oj4cvo85fs#request
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-oj4cvo85fs#request-field-inappinApp | boolean | Optional; explicit presence | Whether in-app notification delivery is enabled. |
Section ID: DOC-API-MODEL-schema-oj4cvo85fs#request-field-pushpush | boolean | Optional; explicit presence | Whether push notification delivery is enabled. |
Section ID: DOC-API-MODEL-schema-oj4cvo85fs#request-field-emailemail | boolean | Optional; explicit presence | Whether email notification delivery is enabled. |
Section ID: DOC-API-MODEL-schema-oj4cvo85fs#request-field-smssms | boolean | Optional; explicit presence | Whether SMS notification delivery is enabled. |
Section ID: DOC-API-MODEL-schema-oj4cvo85fs#request-field-chatchat | boolean | Optional; explicit presence | Whether chat notification delivery is enabled. |
In responses
Section ID: DOC-API-MODEL-schema-oj4cvo85fs#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-oj4cvo85fs#field-inappSection ID: DOC-API-MODEL-schema-oj4cvo85fs#response-field-inappinApp | boolean | Optional; explicit presence | Whether in-app notification delivery is enabled. |
Section ID: DOC-API-MODEL-schema-oj4cvo85fs#field-pushSection ID: DOC-API-MODEL-schema-oj4cvo85fs#response-field-pushpush | boolean | Optional; explicit presence | Whether push notification delivery is enabled. |
Section ID: DOC-API-MODEL-schema-oj4cvo85fs#field-emailSection ID: DOC-API-MODEL-schema-oj4cvo85fs#response-field-emailemail | boolean | Optional; explicit presence | Whether email notification delivery is enabled. |
Section ID: DOC-API-MODEL-schema-oj4cvo85fs#field-smsSection ID: DOC-API-MODEL-schema-oj4cvo85fs#response-field-smssms | boolean | Optional; explicit presence | Whether SMS notification delivery is enabled. |
Section ID: DOC-API-MODEL-schema-oj4cvo85fs#field-chatSection ID: DOC-API-MODEL-schema-oj4cvo85fs#response-field-chatchat | boolean | Optional; explicit presence | Whether chat notification delivery is enabled. |
Where used
Section ID: DOC-API-MODEL-schema-oj4cvo85fs#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 |
| 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 |
Models containing this value
| Model | Relationship |
|---|---|
| GlobalPreferences | Nested in model |
| UpdateWorkflowPreferenceRequest | Nested in model |
| WorkflowPreferences | Nested in model |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-oj4cvo85fs