Skip to content

Update Notification Preference

PUT
/profile/notification-preferences

Update ONE event type, named by event_type.

Singular on purpose, matching the app: a caller that sent the whole map would race with the person changing a different toggle in the browser and silently revert it.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Mirrors user_profile.NotificationPreferenceUpdateRequest.

Updates ONE event type per call - event_type is required and names it. routing and urgency are closed to the app’s VALID_ROUTING / VALID_URGENCY vocabulary (a parity test pins them).

object
bridge_email
Any of:
boolean
bridge_imessage
Any of:
boolean
bridge_roam
Any of:
boolean
bridge_slack
Any of:
boolean
bridge_whatsapp
Any of:
boolean
copilot_bridge
Any of:
boolean
copilot_proactive
Any of:
boolean
enabled
Any of:
boolean
event_type
required

The event to configure, as listed by GET /profile/notification-preferences. An unknown one is refused with the valid list.

string
hot_override
Any of:
boolean
routing
Any of:
string
Allowed values: conversation notify_only off
urgency
Any of:
string
Allowed values: interrupt_now fold_into_brief

Responses

200

Successful Response

object
data
required

An open envelope for a single role, team, member or account record.

Open on purpose. The app’s own response models on this surface grow with the product - RoleResponse gained rep_limits and manages_role_slugs, TeamResponse gained channel counts and a campaign count - and a pinned mirror would SILENTLY DROP whatever it had not caught up on. A dropped permission in a role read is the worst possible kind of stale: it reads as “they do not have it”.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string