Skip to main content
PATCH
Error

Authorizations

X-API-Key
string
header
required

Path Parameters

phone_number_id
string<uuid>
required

Body

application/json

Partial update for a phone number record. All fields are optional.

phone_number
string | null
provider
string | null
country_code
string | null
label
string | null
inbound_agent_id
string<uuid> | null
outbound_agent_id
string<uuid> | null
sms_enabled
boolean | null
server_url
string | null
fallback_phone_number
string | null
provider_account_sid
string | null
capabilities
Capabilities · object | null
is_verified
boolean | null

Response

Successful Response

Full phone number record returned by the API.

id
string
required
phone_number
string
required
user_id
string | null
org_id
string | null
country_code
string | null
provider
string | null
label
string | null
is_verified
boolean | null
capabilities
Capabilities · object | null
inbound_agent_id
string | null
outbound_agent_id
string | null
sms_enabled
boolean | null
server_url
string | null
fallback_phone_number
string | null
provider_account_sid
string | null
created_at
string | null
updated_at
string | null