Sign in
latestOpenAPI 3.1.02026-08-233001841.3 MB

0dcf3303e9d7

phone_numbers

Update a phone number

You need the "Manage Team Phone Numbers" permission to update a group number. You can only update your own personal numbers.

You can:

  • Change a label of your number.
  • Set up call forwarding via forward_to and forward_to_enabled.
  • Set up a voicemail greeting by including a URL of an mp3 recording in voicemail_greeting_url. We require the URL to be secure (i.e. starting with https://).
  • Modify which team members are part of a group number via participants. This should be a list of user IDs.
  • Modify which external phone numbers are part of a group number via phone_numbers. This should be a list of phone numbers in E.164 international format, e.g. "+16503334444".
  • Change how long (in seconds, 15-90) the number rings on inbound calls before moving on (e.g. to voicemail) via inbound_ring_duration.
put/phone_number/{id}/

Path parameters

idstring required

Request body

forward_tostring
forward_to_enabledboolean
inbound_ring_durationinteger

Number of seconds (15-90) to ring this number on inbound calls before moving on (e.g. to voicemail).

labelstring
participantsstring[]
phone_numbersstring[]
press_1_to_acceptboolean
voicemail_greeting_urlstring nullable

Response

Successful response

address_idstring nullable required
bundle_idstring nullable required
carrier'twilio' | 'plivo' required
carrier_type'local' | 'national' | 'mobile' | 'tollfree' | 'shortcode' required
countrystring nullable required
date_createdstring date-time required
date_updatedstring date-time required
forward_tostring nullable
forward_to_enabledboolean
forward_to_formattedstring nullable
idstring required
inbound_ring_durationinteger nullable

Number of seconds we ring this number on inbound calls before moving on (e.g. to voicemail). null means the default of 30 seconds is used.

is_group_numberboolean required

Deprecated. The distinction between personal and group numbers is being removed, and is_group_number will be removed in a future update.

is_premiumboolean required
is_verifiedboolean required
labelstring required
last_billed_pricenumber nullable required
mms_enabledboolean required
next_billing_onstring date-time nullable required
numberstring required
number_formattedstring required
organization_idstring required
participantsstring[]
phone_numbersstring[]
phone_numbers_formattedstring[]
press_1_to_acceptboolean
sms_enabledboolean required
supports_mms_to_countriesstring[] required
supports_sms_to_countriesstring[] required
type'internal' | 'external' | 'virtual' required
user_idstring nullable required

Deprecated. Set to the sole member's user ID for single-member numbers, otherwise null. user_id will be removed in a future update.

voicemail_greeting_urlstring nullable
was_portedboolean