Agents Platform

Update Phone Number

Changed on

Update assigned agent of a phone number

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

Request

  • Base URL
    https://api.elevenlabs.io (the document declares no server; this is the origin it was published from)
  • URL
    https://api.elevenlabs.io/v1/convai/phone-numbers/{phone_number_id}
  • Auth
    none declared

Path parameters

phone_number_idstring required

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

Example:TeaqRRdTcIfIu2i7BYfT

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.

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"
}

Changes

  • 009bd651509aRevision changes
    • info

      added the new optional request property //

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

  • 37fac3c5a2d7Revision changes
    • breaking

      added to the response body oneOf list for the response status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property

    • info

      added exotel mapping keys to the response discriminator for the response status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property / to the response with the status