Skip to main content
PATCH
Update Phone Number

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

phone_number_id
string
required

Body

application/json
label
string | null
Maximum string length: 120
agent_id
string | null

Agent that answers this number's inbound calls. Explicit null unbinds; omit the field to keep the current binding.

Response

Request fulfilled, document follows

phone_number_id
string
required
workspace_id
string
required
phone_number
string
required

E.164, e.g. +14155550123.

provider
enum<string>
required
Available options:
livekit,
twilio
agent_id
string | null
required

Inbound calls route to this agent; unbound numbers ring busy.

status
enum<string>
required
Available options:
provisioning,
active,
error,
released
created_at
string<date-time>
required
updated_at
string<date-time>
required
label
string
default:""
status_detail
string
default:""

What failed when status is error; empty otherwise.