Skip to navigation
Communication ConfigurationPhone Numbers

Update a phone number

View as Markdown

You need the “Manage Team Phone Numbers” permission to change most settings. If you’re the only member of a number and no Group is assigned to it, you can change its label, voicemail greeting, and call forwarding without that permission.

You can:

  • Change the label of the 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 users are assigned directly to the number via participants. This should be a list of user IDs.
  • Modify which Groups are assigned to the number via participant_groups. This should be a list of Group IDs from the Groups API. Members of these Groups, including users added to a Group later, ring on inbound calls, receive notifications for the number, and can use it as outbound caller ID. You can assign at most 40 Groups.
  • Modify which external phone numbers the number dials 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.
  • Let users who are not members of the number use it as their outbound caller ID via non_member_caller_id_enabled.
  • Let Local Presence pick the number for calls and SMS that voice agents make in Auto caller ID mode via voice_agents_local_presence_enabled. You cannot disable this setting while a voice agent uses the number.
  • Let Local Presence pick the number by proximity for calls and SMS via local_presence_enabled.

You can set at most 40 users and external phone numbers combined in participants and phone_numbers.

A number’s ring order is set in Close. A number that rings its members all at once rings at most 40 users and external phone numbers per inbound call. The users in participants and the external phone numbers in phone_numbers take priority. Members of the number’s Groups who are allowed to make calls are added, chosen at random for each call, until 40 users and external phone numbers are ringing.

The per-call limit does not apply to a number that rings its members one at a time (round-robin).

Authentication

AuthorizationBasic
Use your API key as the username and leave the password empty.
OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired

Request

This endpoint expects an object.
forward_tostringOptional
forward_to_enabledbooleanOptional
inbound_ring_durationintegerOptional15-90

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

labelstringOptional
local_presence_enabledbooleanOptional
Whether Local Presence can pick this phone number by proximity for a call or SMS made as a user.
non_member_caller_id_enabledbooleanOptional
Whether users who are not members of this phone number can use it as their outbound caller ID.
participant_groupslist of stringsOptional
participantslist of stringsOptional
phone_numberslist of stringsOptional
press_1_to_acceptbooleanOptional
voice_agents_local_presence_enabledbooleanOptional
Whether Local Presence can pick this phone number for calls and SMS that voice agents make in Auto caller ID mode.
voicemail_greeting_urlstring or nullOptional
voice_agent_caller_id_enabledbooleanOptionalDeprecated

Deprecated. Use voice_agents_local_presence_enabled. This field is an alias of voice_agents_local_presence_enabled, and it will be removed in a future update. If you send both fields, they must have the same value.

Response

Successful response
address_idstring or null
bundle_idstring or null
carrierenum or null
Allowed values:
carrier_typeenum or null
Allowed values:
countrystring or null
date_createddatetime
date_updateddatetime
idstring
is_premiumboolean
is_verifiedboolean
labelstring
last_billed_pricedouble or null
local_presence_enabledboolean
Whether Local Presence can pick this phone number by proximity for a call or SMS made as a user.
mms_enabledboolean
next_billing_ondatetime or null
non_member_caller_id_enabledboolean
Whether users who are not members of this phone number can use it as their outbound caller ID.
numberstring
number_formattedstring
organization_idstring
participant_groupslist of strings
IDs of the Groups assigned to this phone number. Members of these Groups ring on inbound calls, receive notifications for the number, and can use it as outbound caller ID. See the Groups API.
sms_enabledboolean
supports_mms_to_countrieslist of strings
supports_sms_to_countrieslist of strings
typeenum
Allowed values:
voice_agents_local_presence_enabledboolean
Whether Local Presence can pick this phone number for calls and SMS that voice agents make in Auto caller ID mode.
is_group_numberbooleanDeprecated

This field is deprecated and will be removed in a future update. Until then, it is set to false when participants has exactly one user and the phone number doesn’t have any of the “shared” configuration set up (e.g. a phone menu, lead-based routing, a dial-out list, an assigned Group, a non-default ring order, etc.), and true otherwise.

user_idstring or nullDeprecated

This field is deprecated. See the participants and participant_groups fields instead to learn who’s assigned to this phone number. This user_id field will be removed in a future update. Until then, it is set to a specific user ID only if the given phone number has a single participant and no additional “shared” configuration (e.g. a phone menu, lead-based routing, a dial-out list, an assigned Group, a non-default ring order, etc.).

voice_agent_caller_id_enabledbooleanDeprecated

Deprecated. Use voice_agents_local_presence_enabled. This field has the same value as voice_agents_local_presence_enabled, and it will be removed in a future update.

forward_tostring or nullOptional
forward_to_enabledbooleanOptional
forward_to_formattedstring or nullOptional
inbound_ring_durationinteger or nullOptional

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.

participantslist of stringsOptional

IDs of the users assigned directly to this phone number. Members of the Groups in participant_groups also ring on inbound calls, receive notifications for the number, and can use it as outbound caller ID.

phone_numberslist of stringsOptional

Present unless participants has exactly one user and the phone number has no shared-number configuration (a phone menu, lead-based routing, a dial-out list, an assigned Group, or a non-default ring order).

phone_numbers_formattedlist of stringsOptional

Present under the same condition as phone_numbers, with each value formatted for display.

press_1_to_acceptbooleanOptional
voicemail_greeting_urlstring or nullOptional
was_portedbooleanOptional

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error