Skip to content

Update Preferences

PUT
/profile/preferences

Update preferences. Omitted fields are LEFT ALONE, not cleared.

whatsapp_number is validated against the messaging bridge before anything is written: claiming a number another person in the organisation already registered is refused rather than silently stealing their route.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Mirrors user_profile.PreferencesUpdateRequest.

Every field optional; omitted fields are left alone.

object
default_view
Any of:
string
locale
Any of:
string
mcp_default_client
Any of:
string
mcp_tool_group
Any of:
string
mcp_widgets_enabled
Any of:
boolean
notifications_email
Any of:
boolean
notifications_in_app
Any of:
boolean
notifications_slack
Any of:
boolean
theme
Any of:
string
timezone
Any of:
string
whatsapp_number
Any of:
string

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