PUT
Update Phone Number
Changing inbound_workflow_id re-syncs the inbound webhook with the provider; the response includes a provider_sync block with the result. To remove an existing inbound binding, send clear_inbound_workflow: true. Sending inbound_workflow_id: null alone is treated as β€œno change”.

Authorizations

Authorization
string
header
required

An EESI API key (sk-eesi-...) or a Clerk session token.

Headers

authorization
string | null
X-API-Key
string | null

Path Parameters

config_id
integer
required
phone_number_id
integer
required

Body

application/json

Partial update. address is intentionally immutable β€” to change a number, delete the row and create a new one.

label
string | null
Maximum string length: 64
inbound_workflow_id
integer | null
clear_inbound_workflow
boolean
default:false
is_active
boolean | null
country_code
string | null
Required string length: 2
extra_metadata
Extra Metadata Β· object | null

Response

Successful Response

id
integer
required
telephony_configuration_id
integer
required
address
string
required
address_normalized
string
required
address_type
string
required
is_active
boolean
required
is_default_caller_id
boolean
required
extra_metadata
Extra Metadata Β· object
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
country_code
string | null
label
string | null
inbound_workflow_id
integer | null
inbound_workflow_name
string | null
provider_sync
ProviderSyncStatus Β· object | null

Result of pushing a phone-number change to the upstream provider.

Returned alongside create/update responses when the route attempted to sync inbound webhook configuration. ok=False is a warning, not a fatal error β€” the DB write succeeded.