POST
Create Phone Number

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

Body

application/json

Create a new phone number under a telephony configuration.

address_normalized and address_type are computed server-side from address (and country_code if PSTN). address itself is stored verbatim for display.

address
string
required
Required string length: 1 - 255
country_code
string | null
Required string length: 2
label
string | null
Maximum string length: 64
inbound_enabled
boolean
default:false
inbound_instructions
string | null
Maximum string length: 8000
is_active
boolean
default:true
is_default_caller_id
boolean
default:false
extra_metadata
Extra Metadata · object

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_enabled
boolean
default:false
inbound_instructions
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 bind the number to our inbound webhook at the carrier. ok=False is a warning, not a fatal error — the database write succeeded, and the number simply will not ring through until the sync is retried.