Skip to main content
PATCH
Update phone number configuration

Path Parameters

phoneNumberId
string<uuid>
required

The ID of the phone number to update

Body

Payload to update phone number configuration. Only provided fields will be updated. The phone number's voice must support its language, so changing the language may also require providing a compatible voiceId in the same request.

language
enum<string>

The language of the phone number. ENGLISH_SPANISH supports bilingual English/Spanish calls.

Available options:
ENGLISH,
ENGLISH_SPANISH,
SPANISH,
FRENCH
verifiedCallerId
string | null

Verified caller ID for outbound calls. Must be pre-registered and verified for the organization.

callbackForwardingNumber
string | null

If a recipient calls back an outbound number, the call will be forwarded to this phone number. Note: This field will be ignored for inbound numbers and only applied to outbound numbers.

voiceId
enum<string>

The voice of the phone number. Each voice supports a single language and must match the phone number's language: WARM_ENGLISH_SPANISH requires ENGLISH_SPANISH, WARM_SPANISH requires SPANISH, WARM_FRENCH requires FRENCH, and all other voices require ENGLISH.

Available options:
FRIENDLY_BRIGHT,
CALM_REASSURING,
POLISHED_PROFESSIONAL,
KIND_CURIOUS,
CONFIDENT_UPBEAT,
WARM_ENGLISH_SPANISH,
WARM_SPANISH,
WARM_FRENCH
customGreeting
string | null

Custom greeting spoken verbatim as the first words of inbound calls on this number. Overrides the bot's greeting, so write it in the phone number's language. Send null to clear it.

Maximum string length: 500
customClosedGreeting
string | null

Custom greeting spoken verbatim when an inbound call arrives outside office hours. Overrides the bot's closed phone greeting, so write it in the phone number's language. Send null to clear it.

Maximum string length: 500

Response

Response returned after updating phone number configuration

success
enum<boolean>
required
Available options:
true
data
object
required

Represents a phone number and its configuration