Skip to main content
PATCH
cURL

Authorizations

Authorization
string
header
required

JWT Bearer token obtained from authentication. Pass as: Authorization: Bearer

Path Parameters

phoneIdentityId
string
required

The number to update

Body

application/json

Update one phone number's settings

voiceId
string | null
required

Voice id from the catalog, or null to fall back to the agent's voice. Rejected if the id is not in the catalog.

Response

200 - application/json

OK

Phone identity associated with an agent

id
string
required

Unique identifier of the phone identity

Pattern: ^[cC][^\s-]{8,}$
phoneNumber
string
required

Phone number in E.164 format

providerId
string | null
required

Opaque carrier-side identifier for this phone number

capabilities
object
required

Communication capabilities supported by this phone number

tenDlcStatus
enum<string>
required

10DLC campaign registration status

Available options:
PENDING,
REGISTERED,
REJECTED,
NOT_REQUIRED,
UNREGISTERED
isPrimary
boolean
required

Whether this is the agent's primary phone identity

voiceId
string | null
required

The voice this number answers with, from the voice catalog. Null means it uses the agent's voice, and then the system default. Set it per number so one agent's support line and sales line can sound different.

createdAt
string<date-time>
required

Timestamp when the phone identity was created