Skip to main content
PATCH
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 numbers.

Body

application/json
agent_caller_id_name
string | null

With assigned_agent_id: the name shown on calls instead of the agent's.

Maximum string length: 40
alpha_sender
string | null

Alphanumeric sender ID for texts abroad: 1 to 11 characters with a letter. Empty clears it.

Maximum string length: 64
assigned_agent_id
string | null

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

caller_id_name
string | null

The name recipients see on calls (CNAM), up to 15 letters and digits.

Required string length: 1 - 40
inbound_agent_id
string | null

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

outbound_profile
Outbound Profile · object | null

Create an outbound calling profile for this number.

outbound_setup
Outbound Setup · object | null

Outbound calling settings for this number.

verified_caller_id
string | null

A verified caller ID's id to show on outbound calls. Send null to clear it.

Response

Successful Response

inbound
Inbound · object | null

Inbound returned by the Sendora API.

outbound_profile
Outbound Profile · object | null

Outbound profile returned by the Sendora API.

outbound_setup
Outbound Setup · object | null

Outbound setup returned by the Sendora API.

settings
Settings · object | null

Settings returned by the Sendora API.