Skip to main content
PATCH
Update phone number

Authorizations

X-API-KEY
string
header
required

Path Parameters

phone_number_id
string
required

The phone number id.

Body

application/json

At least one recognized field is required.

display_name
string | null

Human label; empty/whitespace is stored as null.

outbound_enabled
boolean

Enable/disable outbound caller ID use.

inbound_enabled
boolean

Enable/disable inbound answering; reconciles LiveKit inbound routing.

inbound_agent_id
string | null

Published agent to answer inbound calls; null to clear.

metadata
object | null

Replaces the stored metadata object.

auth_password
string
write-only

For BYO-trunk numbers only: the SIP password, used solely to re-provision inbound. Write-only — never persisted or returned.

Response

Updated phone number.