Docs
Update Preferences
PATCH /notification-preferences
PATCH
/notification-preferencesUpdates the caller's notification preferences and returns the result. Send only what changes: an email address, channel switches, or per-event-type changes for a channel through assignmentUpdates.
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| emailAddress | string | Optional | |
| inAppEnabled | boolean | Optional | |
| emailEnabled | boolean | Optional | |
| pushEnabled | boolean | Optional | |
| smsEnabled | boolean | Optional | |
| channelToggles | ChannelToggle[] | Optional | |
| assignmentUpdates | AssignmentUpdate[] | Optional |
ChannelToggle
| Field | Type | Description |
|---|---|---|
| channel | string| null | |
| enabled | boolean |
AssignmentUpdate
| Field | Type | Description |
|---|---|---|
| channel | string| null | |
| eventType | string| null | |
| enabled | boolean |
Response
| Field | Type | Description |
|---|---|---|
| userId | uuid | |
| inAppEnabled | boolean | |
| emailEnabled | boolean | |
| pushEnabled | boolean | |
| smsEnabled | boolean | |
| emailAddress | string| null | |
| assignments | string| null |