Developer
Developer - Phone Numbers

Update Phone Number

Changed on

Update a phone number entry.

This endpoint is restricted to developer users only. Updates the label or active status of a phone number.

  • label: Optional friendly label
  • is_active: Optional active status
patch/developer/phone-numbers/{phone_number_id}

Request

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

Path parameters

phone_number_idstring uuid required

Request body

labelstring nullable

Friendly label

is_activeboolean nullable

Active status

is_testboolean nullable

Whether this is a test number

provider'twilio' | 'daily' | 'vapi' nullable

Telephony provider

agent_platform'pipecat' | 'vapi' nullable

Voice agent platform

inbound_squad_idstring nullable

Vapi squad ID for inbound assistant-request routing

outbound_squad_idstring nullable

Vapi squad ID for outbound calls

outbound_squad_id_esstring nullable

Vapi squad ID for outbound calls to Spanish-language leads (falls back to outbound_squad_id)

business_hours_inbound_squad_idstring nullable

Vapi squad ID for inbound calls during business hours (used when business_hours_enabled feature flag is on)

after_hours_inbound_squad_idstring nullable

Vapi squad ID for inbound calls outside business hours (used when business_hours_enabled feature flag is on)

outbound_enabledboolean nullable

Whether this number is available for automated outbound dialing

provider_bypass_enabledboolean nullable

Route inbound Twilio calls through our own /telephony/inbound-vapi endpoint instead of Vapi's inbound webhook. Required for attended transfer, which needs Twilio call control to stay on our side

is_bounce_backboolean nullable

Dedicated bounce-back return line: unanswered transferred calls forwarded back here are matched to their original call and the conversation is injected into the inbound squad

is_staff_transferboolean nullable

Dedicated staff-to-AI transfer line: the PBX AI extension forwards here; the caller is matched to the AI call they were transferred out of, which stays canonical and absorbs this leg

bounce_back_intake_squad_idstring nullable

Vapi squad ID for bounce-backs whose original call was transferred to intake (Intake Dept / On Call); falls back to inbound_squad_id

vapi_phone_number_idstring nullable

VAPI phone number resource ID (for outbound API calls)

default_greeting_overridestring nullable

Per-number default greeting; overrides the customer-wide default/business-hours greeting selection for calls to this number

contact_greeting_overridestring nullable

Per-number known-contact greeting template ({first_name}/{last_name}); overrides the customer-wide contact greeting for calls to this number

Response

Successful Response

phone_numberstring required

Phone number or SIP endpoint (e.g., +15551234567 or 1000)

labelstring nullable

Friendly label like 'Main Line' or 'After Hours'

is_activeboolean required

Whether the number is active

is_testboolean required

Whether this is a test number (calls won't make real changes)

provider'twilio' | 'daily' | 'vapi' required

Telephony provider (twilio, daily, or vapi)

agent_platform'pipecat' | 'vapi'

Voice agent platform: 'pipecat' or 'vapi'

inbound_squad_idstring nullable

Vapi squad ID for inbound assistant-request routing

outbound_squad_idstring nullable

Vapi squad ID for outbound calls

outbound_squad_id_esstring nullable

Vapi squad ID for outbound calls to Spanish-language leads (falls back to outbound_squad_id)

business_hours_inbound_squad_idstring nullable

Vapi squad ID for inbound calls during business hours (used when business_hours_enabled feature flag is on)

after_hours_inbound_squad_idstring nullable

Vapi squad ID for inbound calls outside business hours (used when business_hours_enabled feature flag is on)

outbound_enabledboolean

Whether this number is available for automated outbound dialing

provider_bypass_enabledboolean

Route inbound Twilio calls through our own /telephony/inbound-vapi endpoint instead of Vapi's inbound webhook. Required for attended transfer, which needs Twilio call control to stay on our side

is_bounce_backboolean

Dedicated bounce-back return line: unanswered transferred calls forwarded back here are matched to their original call and the conversation is injected into the inbound squad

is_staff_transferboolean

Dedicated staff-to-AI transfer line: the PBX AI extension forwards here; the caller is matched to the AI call they were transferred out of, which stays canonical and absorbs this leg

bounce_back_intake_squad_idstring nullable

Vapi squad ID for bounce-backs whose original call was transferred to intake (Intake Dept / On Call); falls back to inbound_squad_id

vapi_phone_number_idstring nullable

VAPI phone number resource ID (for outbound API calls)

default_greeting_overridestring nullable

Per-number default greeting; overrides the customer-wide default/business-hours greeting selection for calls to this number

contact_greeting_overridestring nullable

Per-number known-contact greeting template ({first_name}/{last_name}); overrides the customer-wide contact greeting for calls to this number

phone_number_idstring uuid required

Phone number ID

customer_idstring uuid required

Customer ID

created_atstring required

Creation timestamp

type'PSTN' | 'SIP' required

Derived phone number type based on format.

Changes

  • 5d668a9fc9ddRevision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

  • 40f22baa60d7Revision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status