Skip to main content
PATCH
Update Phone Number

Headers

x-api-key
string | null

Your API key for programmatic access. Send it in the x-api-key header; you can create and manage keys from the Developers page.

Path Parameters

phone_number_id
string
required

The phone number ID. This is returned when a phone number is imported.

Example:

"TeaqRRdTcIfIu2i7BYfT"

Body

application/json

Patch Phone Request Information

agent_id
string | null
label
string | null
inbound_trunk_config
InboundSIPTrunkConfigRequestModel · object | null
outbound_trunk_config
OutboundSIPTrunkConfigRequestModel · object | null
livekit_stack
enum<string> | null
Available options:
standard,
static
store_sip_messages
boolean | null
environment
string | null

Environment to use for resolving environment variables on calls to this number.

branch_id
string | null

Agent branch to use for calls to this number.

Response

Successful Response

phone_number
string
required

Phone number

label
string
required

Label for the phone number

phone_number_id
string
required

The ID of the phone number

assigned_agent
PhoneNumberAgentInfo · object | null

The agent that is assigned to the phone number

Example:
provider
string
default:twilio

Phone provider

Allowed value: "twilio"