Extensions

Patch Extension

Replace parameters on an individual extension, only provided parameters will be replaced.

patch/v4/accounts/{voip_id}/extensions/{extension_id}

Request

  • Base URL: https://api.phone.com
  • URL: https://api.phone.com/v4/accounts/{voip_id}/extensions/{extension_id}
  • Auth: HTTP bearer

Path parameters

voip_idinteger required
extension_idinteger required

Request body

usage_type'limited' | 'unlimited'

Can be 'limited' or 'unlimited'. In most cases, changing this will affect your monthly bill.

extensioninteger nullable

Extension number that callers may dial. On POST, leaving this empty will result in an auto-generated value. On PUT, this field is required.

full_namestring nullable

Full name of the individual or department to which this extension is assigned

namestring nullable

User-supplied name for the extension. On POST, leaving this empty will result in an auto-generated value. On PUT, this field is required

timezonestring nullable

Time zone in IANA time zone database format (like 'America/Los_Angeles')

include_in_directoryboolean nullable

Whether this extension should be included in the dial-by-name directory for this account.

caller_idstring nullable

Phone number to use as Caller ID for outgoing calls. Must be a phone number belonging to this account, or one of any additional authorized phone number

local_area_codeinteger nullable

For outbound calls, this is the North American area code that this extension is calling from

enable_call_waitingboolean nullable

Whether Call Waiting is enabled. Default is TRUE

enable_outbound_callsboolean nullable

Whether outgoing calls are enabled. Default is TRUE.

bypass_hard_phoneboolean nullable

Set 'true' if you want to use advanced call handling rules instead of device

presence_publishboolean nullable
presence_subscribeboolean nullable
routeunknown

Response

OK

object required

Changes

No operation changes recorded.