Skip to main content
PATCH
Update phone number

Authorizations

Authorization
string
header
required

Use Authorization: Bearer tc_live_xxxxx

Path Parameters

phone_number_id
string<uuid>
required

Phone number UUID

Body

application/json

Every field is optional, but the body must include at least one.

label
string

User-friendly label

Required string length: 1 - 200
status
enum<string>

Only active or inactive may be set manually. A number currently failed or pending cannot have its status changed.

Available options:
active,
inactive

Response

Phone number updated

id
string<uuid>

Phone number UUID

account_id
string<uuid>

Account UUID

number
string

Phone number in E.164 format

Example:

"+18005551234"

source
enum<string>

Phone number source:

  • topcalls - TopCalls default carrier
  • byoc - Bring Your Own Carrier
  • manual - Manually added
  • import - Imported from external source
Available options:
topcalls,
byoc,
manual,
import,
twilio
status
enum<string>

Phone number status:

  • active - Ready to use
  • inactive - Disabled but still provisioned
  • pending - Provisioning in progress
  • failed - Provisioning failed
  • deleted - Soft deleted
Available options:
active,
inactive,
pending,
failed,
deleted
phone_number_sid
string<uuid> | null

Provisioned phone number ID in the telephony system

voip_carrier_sid
string<uuid> | null

Carrier UUID

carrier_name
string | null

Carrier display name

label
string | null

User-friendly label

error_message
string | null

Error details when status is 'failed'

created_by_user_id
string<uuid> | null

User who created this number

created_at
string<date-time>
updated_at
string<date-time>