Update Phone Number

PATCH

https://api.vapi.ai/phone-number/:id

PATCH

/phone-number/:id

curl -X PATCH https://api.vapi.ai/phone-number/id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

200Updated

{
  "provider": "byo-phone-number",
  "createdAt": "2024-01-15T09:30:00Z",
  "credentialId": "string",
  "id": "string",
  "orgId": "string",
  "updatedAt": "2024-01-15T09:30:00Z",
  "assistantId": "string",
  "fallbackDestination": {
    "callerId": "string",
    "description": "string",
    "extension": "string",
    "message": "string",
    "name": "string",
    "number": "string",
    "numberE164CheckEnabled": true,
    "transferPlan": {
      "contextEngineeringPlan": {
        "maxMessages": 1.1,
        "type": "lastNMessages"
      },
      "dialTimeout": 60,
      "fallbackPlan": {
        "endCallEnabled": true,
        "message": "string"
      },
      "holdAudioUrl": "string",
      "message": "string",
      "mode": "blind-transfer",
      "sipHeadersInReferToEnabled": true,
      "sipVerb": "refer",
      "summaryPlan": {
        "enabled": true,
        "messages": [
          {}
        ],
        "timeoutSeconds": 1.1
      },
      "timeout": 60,
      "transferCompleteAudioUrl": "string",
      "twiml": "string"
    },
    "type": "number"
  },
  "hooks": [
    {
      "do": [
        {
          "destination": {
            "callerId": "string",
            "description": "string",
            "extension": "string",
            "message": "string",
            "name": "string",
            "number": "string",
            "numberE164CheckEnabled": true,
            "transferPlan": {
              "contextEngineeringPlan": {
                "maxMessages": 1.1,
                "type": "lastNMessages"
              },
              "dialTimeout": 60,
              "fallbackPlan": {
                "endCallEnabled": true,
                "message": "string"
              },
              "holdAudioUrl": "string",
              "message": "string",
              "mode": "blind-transfer",
              "sipHeadersInReferToEnabled": true,
              "sipVerb": "refer",
              "summaryPlan": {
                "enabled": true,
                "messages": [
                  {}
                ],
                "timeoutSeconds": 1.1
              },
              "timeout": 60,
              "transferCompleteAudioUrl": "string",
              "twiml": "string"
            },
            "type": "number"
          },
          "type": "transfer"
        }
      ],
      "filters": [
        {
          "key": "number",
          "startsWith": [
            "91",
            "86",
            "7"
          ],
          "type": "startsWith"
        }
      ],
      "on": "call.ringing"
    }
  ],
  "name": "string",
  "number": "string",
  "numberE164CheckEnabled": true,
  "server": {
    "timeoutSeconds": 20,
    "credentialId": "550e8400-e29b-41d4-a716-446655440000",
    "staticIpAddressesEnabled": false,
    "encryptedPaths": [
      "string"
    ],
    "url": "string",
    "headers": {},
    "backoffPlan": {
      "type": "fixed",
      "maxRetries": 0,
      "baseDelaySeconds": 1,
      "excludedStatusCodes": [
        400,
        401,
        403,
        404
      ]
    }
  },
  "squadId": "string",
  "status": "active",
  "workflowId": "string"
}

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.

Authenticate server-side requests with a private Vapi API key. Create or copy a key from the [Vapi Dashboard](https://dashboard.vapi.ai) 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.

twilioobjectRequired

Fields used to update a Twilio phone number, including its account credentials, SMS configuration, routing, hooks, and server settings.

vonageobjectRequired

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

vapiobjectRequired

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

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.

twilioobject

A Twilio phone number connected to Vapi, including its Twilio account details, SMS configuration, routing, hooks, server settings, and lifecycle metadata.

vonageobject

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

vapiobject

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

telnyxobject

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