PATCH
/
update-phone-number
/
{phone_number}

Authorizations

Authorization
string
headerrequired

Authentication header containing API key (find it in dashboard). The format is "Bearer YOUR_API_KEY"

Path Parameters

phone_number
string
required

E.164 format of the number (+country code, then number with no space, no special characters), used as the unique identifier for phone number APIs.

Body

application/json
inbound_agent_id
string | null

Unique id of agent to bind to the number. The number will automatically use the agent when receiving inbound calls. If set to null, this number would not accept inbound call.

outbound_agent_id
string | null

Unique id of agent to bind to the number. The number will automatically use the agent when conducting outbound calls. If set to null, this number would not be able to initiate outbound call without agent id override.

nickname
string | null

Nickname of the number. This is for your reference only.

Response

200 - application/json
phone_number
string
required

E.164 format of the number (+country code, then number with no space, no special characters), used as the unique identifier for phone number APIs.

last_modification_timestamp
integer
required

Last modification timestamp (milliseconds since epoch). Either the time of last update or creation if no updates available.

phone_number_pretty
string

Pretty printed phone number, provided for your reference.

inbound_agent_id
string | null

Unique id of agent to bind to the number. The number will automatically use the agent when receiving inbound calls. If null, this number would not accept inbound call.

outbound_agent_id
string | null

Unique id of agent to bind to the number. The number will automatically use the agent when conducting outbound calls. If null, this number would not be able to initiate outbound call without agent id override.

area_code
integer

Area code of the number to obtain. Format is a 3 digit integer. Currently only supports US area code.

nickname
string | null

Nickname of the number. This is for your reference only.

Was this page helpful?

List Phone NumbersDelete Phone Number