Skip to main content
PUT
Update a phone number

Authorizations

Authorization
string
header
required

Your organization API key (it starts with anek_org_). The same key works on the Voice API and the Support API. See Authentication.

Path Parameters

projectId
string
required

Project id

id
string
required

Phone number id

Body

application/json

Send at least one field; the others keep their value. The number (e164) cannot be changed and is ignored if sent. provider and sip_trunk_id cannot both be set after the update; set both to null to leave the number unassigned.

provider
enum<string> | null

The carrier the number comes from. null removes it.

Available options:
twilio,
didww,
null
sip_trunk_id
string | null

Move the number to this inbound SIP trunk of the project. null takes it off its trunk.

Minimum string length: 1
voice_inbound
boolean

The number takes inbound calls.

voice_outbound
boolean

Agents may place outbound calls from the number. Turning it off while outbound_trunk_ids is not empty is refused (422); clear the list in the same request.

outbound_trunk_ids
string[]

The whole ordered list of outbound SIP trunks, replacing the stored one. [] clears it.

Maximum array length: 5
Minimum string length: 1
max_calls_per_second
integer

The most inbound calls per second the number accepts. Raising it above 5 is done by Clarity support (403 otherwise); resending the current value is always accepted.

Required range: 1 <= x <= 100
abuse_protection_exempt
boolean

Leave the number out of the project's inbound abuse protection.

Response

The updated phone number.

phone_number
object
required

A phone number of the project. Its inbound calls come from a carrier (provider) or from one of your inbound SIP trunks (sip_trunk_id), never both; with neither, the number is unassigned.

max_calls_per_second_self_serve_max
integer

Returned when you read a number: the highest max_calls_per_second you can set yourself. Higher limits are set by Clarity support.