Skip to main content
PATCH
Update per-user preferences

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

X-Test-Mode
enum<string>

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

Available options:
true,
false

Body

application/json
softphone_layout
enum<string> | null

Softphone widget layout. NULL resets to the platform default.

Available options:
compact_bottom_bar,
floating_panel,
side_panel,
null
voicemail_to_email_enabled
boolean

When TRUE every voicemail assigned to this user triggers an audio-attached email via the dispatcher scheduler.

voicemail_to_email_address
string<email> | null

Alternate routing address. NULL clears to users.email.

Maximum string length: 320
inbox_signature
string | null

Operator signature block (≤ 2 000 chars). NULL or whitespace-only string clears the persisted value.

Maximum string length: 2000
inbox_show_archived_tags
boolean

Inbox → Settings → Conversation tags 'Show archived tags' view toggle. Persisted so the choice survives reload + multi-device.

Response

Successful response.

data
object
required
meta
object
required