Skip to main content
PATCH
Update a phone number

Authorizations

Authorization
string
header
required

API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, settings:write, platform:read, platform:write; a *:write scope implies the matching *:read. Automation and dashboard endpoints also accept the legacy calls:* scope. Keys without scope restrictions have full access.

Path Parameters

id
string<uuid>
required

Phone number ID.

Body

application/json

Partial update. When assistant_id, sip_trunk_id or direction_inbound change, the inbound SIP dispatch rule is re-created (or removed). Marketplace platform number label can only be changed by a platform admin in the app UI.

assistant_id
string<uuid> | null

null unassigns the assistant.

sip_trunk_id
string<uuid> | null
direction_inbound
boolean
direction_outbound
boolean
label
string | null

Optional UI display label under the E.164 (not sent to carriers). Null or empty clears it.

Response

The updated phone number.

data
object
required