Skip to main content
PATCH
Error

Authorizations

X-Api-Key
string
header
required

API key sent in the X-Api-Key header. Generate an API key from https://app.atonom.ai/#/settings/v2/api_keys.

Path Parameters

id
string
required

Identifier of the phone number.

Required string length: 10 - 21
Pattern: ^[A-Za-z2-7]+-[A-Za-z2-7]{4,}$
Example:

"AUIAC-EXQA"

Body

application/json
name
string

New display name. Omit to leave unchanged. JSON null and "" are invalid (empty name is not allowed; name cannot be cleared).

Minimum string length: 1
Example:

"Renamed line"

inbound_cloud_employee_id
string | null

The cloud employee handling inbound calls. Omit leaves the current assignment unchanged; null clears it; a value sets it.

Required string length: 10 - 21
Pattern: ^[A-Za-z2-7]+-[A-Za-z2-7]{4,}$
Example:

"AUIAE-DUXA"

outbound_cloud_employee_id
string | null

The cloud employee handling outbound calls. Omit leaves the current assignment unchanged; null clears it; a value sets it.

Required string length: 10 - 21
Pattern: ^[A-Za-z2-7]+-[A-Za-z2-7]{4,}$
Example:

"AUIAE-DUXA"

Response

OK

id
string
required
read-only

Identifier of the phone number.

Required string length: 10 - 21
Pattern: ^[A-Za-z2-7]+-[A-Za-z2-7]{4,}$
Example:

"AUIAC-EXQA"

name
string
required

Display name of the phone number.

Example:

"Main line"

e164
string
required
read-only

Phone number in E.164 format.

Example:

"+15551234567"

area_code
string
required

NANP area code.

Example:

"555"

inbound_cloud_employee_id
string

Identifier of the cloud employee handling inbound calls.

Required string length: 10 - 21
Pattern: ^[A-Za-z2-7]+-[A-Za-z2-7]{4,}$
Example:

"AUIAE-DUXA"

outbound_cloud_employee_id
string

Identifier of the cloud employee handling outbound calls.

Required string length: 10 - 21
Pattern: ^[A-Za-z2-7]+-[A-Za-z2-7]{4,}$
Example:

"AUIAE-DUXA"