Update a phone number

View as Markdown
You need the "Manage Group 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".

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:)>.

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
labelstringOptional
participantslist of stringsOptional
phone_numberslist of stringsOptional
press_1_to_acceptbooleanOptional
voicemail_greeting_urlstring or nullOptional

Response

Successful response
address_idstring or null
bundle_idstring or null
carrierenum or null
Allowed values:
carrier_typeenum or null
The type of number the carrier has rented.
Allowed values:
countrystring or null
date_createddatetime
date_updateddatetime
idstring
is_group_numberboolean
is_premiumboolean
is_verifiedboolean
labelstring
last_billed_pricedouble or null
mms_enabledboolean
next_billing_ondatetime or null
numberstring
number_formattedstring
organization_idstring
sms_enabledboolean
supports_mms_to_countrieslist of strings
supports_sms_to_countrieslist of strings
typeenum
Allowed values:
user_idstring or null
forward_tostring or null
forward_to_enabledboolean
forward_to_formattedstring or null
participantslist of strings
phone_numberslist of strings
phone_numbers_formattedlist of strings
press_1_to_acceptboolean
voicemail_greeting_urlstring or null
was_portedboolean

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error