Update a phone number
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
id
Request
This endpoint expects an object.
forward_to
forward_to_enabled
label
participants
phone_numbers
press_1_to_accept
voicemail_greeting_url
Response
Successful response
address_id
bundle_id
carrier
Allowed values:
carrier_type
The type of number the carrier has rented.
Allowed values:
country
date_created
date_updated
id
is_group_number
is_verified
label
last_billed_price
mms_enabled
next_billing_on
number
number_formatted
organization_id
sms_enabled
supports_mms_to_countries
supports_sms_to_countries
type
Allowed values:
user_id
forward_to
forward_to_enabled
forward_to_formatted
participants
phone_numbers
phone_numbers_formatted
press_1_to_accept
voicemail_greeting_url
was_ported
Errors
400
Bad Request Error
401
Unauthorized Error
404
Not Found Error