Sign in

v5

latestOpenAPI 3.1.02026-08-043621,4011.8 MB
Agents Platform

Update Phone Number

Update assigned agent of a phone number

patch/v1/convai/phone-numbers/{phone_number_id}

Path parameters

phone_number_idstring required

The phone number ID. This is returned when a phone number is imported.

Example:TeaqRRdTcIfIu2i7BYfT

The phone number ID. This is returned when a phone number is imported.

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Request body

agent_idstring nullable
labelstring nullable
livekit_stack'standard' | 'static'
store_sip_messagesboolean nullable
environmentstring nullable

Environment to use for resolving environment variables on calls to this number.

branch_idstring nullable

Agent branch to use for calls to this number.

Response

Successful Response

OR
OR

Example response

{
  "label": "Customer Support",
  "phone_number": "+1234567890",
  "phone_number_id": "phone_123",
  "provider": "twilio"
}