Skip to main content
PUT
cURL

Authorizations

X-API-Key
string
header
required

Customer API key created in the Sendora dashboard.

Headers

X-API-Key
string | null
Authorization
string | null

Path Parameters

number_id
string
required

The phone number's id: the id from List connected phone numbers.

Body

application/json
outbound_voice_profile_id
string | null

The outbound calling profile to use: an id from Get outbound calling setup options.

Minimum string length: 1

Response

Successful Response

id
string
required

The phone number's id. Pass it to any endpoint that takes number_id.

number
string
required

Number returned by the Sendora API.

status
string
required

Status returned by the Sendora API.

assigned_agent_id
string | null

The voice agent this is assigned to: an id from List voice agents.

capability_readiness
Capability Readiness · object

Capability readiness returned by the Sendora API.

inbound_agent_id
string | null

The voice agent that answers incoming calls: an id from List voice agents.

inbound_agent_name
string | null

Inbound agent name returned by the Sendora API.

provisioning_state
string | null

Provisioning state returned by the Sendora API.

source
string | null

Source returned by the Sendora API.

supports_mms
boolean | null

Supports mms returned by the Sendora API.

supports_sms
boolean | null

Supports sms returned by the Sendora API.

supports_voice
boolean | null

Supports voice returned by the Sendora API.