Skip to navigation
Phone Numbers

Update Phone Number

Updates the specified fields of the phone number resource identified by its ID.

Authentication

AuthorizationBearer

Authenticate server-side requests with a private Vapi API key. Create or copy a key from the Vapi Dashboard and send it in the Authorization header as Bearer <token>. Keep private API keys out of client-side code and public repositories.

Path parameters

idstringRequiredformat: "uuid"
The unique identifier of the phone number.

Request

This endpoint expects an object.
byo-phone-numberobjectRequired

Fields used to update a bring-your-own phone number, including its credential, number, routing, hooks, and server settings.

OR
twilioobjectRequired
Fields used to update a Twilio phone number, including its account credentials, SMS configuration, routing, hooks, and server settings.
OR
vonageobjectRequired
Fields used to update a Vonage phone number, including its credential, number, routing, hooks, and server settings.
OR
vapiobjectRequired

Fields used to update a Vapi-managed phone number or SIP URI, including its authentication, routing, hooks, and server settings.

OR
telnyxobjectRequired
Fields used to update a Telnyx phone number, including its credential, number, routing, hooks, and server settings.

Response

byo-phone-numberobject

A phone number connected to Vapi through a bring-your-own telephony provider, including its credential, routing, hooks, server settings, and lifecycle metadata.

OR
twilioobject
A Twilio phone number connected to Vapi, including its Twilio account details, SMS configuration, routing, hooks, server settings, and lifecycle metadata.
OR
vonageobject
A Vonage phone number connected to Vapi, including its credential, routing, hooks, server settings, and lifecycle metadata.
OR
vapiobject

A Vapi-managed phone number or SIP URI, including its authentication, routing, hooks, server settings, and lifecycle metadata.

OR
telnyxobject
A Telnyx phone number connected to Vapi, including its credential, routing, hooks, server settings, and lifecycle metadata.