Update a phone number

PUT

https://api.close.com/api/v1/phone_number/:id/

PUT

/api/v1/phone_number/:id/

$ curl -X PUT https://api.close.com/api/v1/phone_number/id/ \
>      -H "Content-Type: application/json" \
>      -u "<CLOSE_API_KEY>:" \
>      -d '{
>   "forward_to": "+16502221111",
>   "forward_to_enabled": true,
>   "inbound_ring_duration": 45,
>   "label": "My number w/ forwarding",
>   "voicemail_greeting_url": "https://s3.amazonaws.com/bucket/aaa-bbb-ccc.mp3"
> }'

1 {
2   "address_id": null,
3   "bundle_id": null,
4   "carrier": null,
5   "carrier_type": null,
6   "country": "US",
7   "date_created": "2016-07-18T22:54:24.787000+00:00",
8   "date_updated": "2016-07-22T22:55:55.938000+00:00",
9   "id": "phon_asdjkfev50ZKOqTVndOFN4effzv99vDvpDxrks9XLU3",
10   "is_group_number": false,
11   "is_premium": false,
12   "is_verified": true,
13   "label": "My number w/ forwarding",
14   "last_billed_price": null,
15   "mms_enabled": true,
16   "next_billing_on": null,
17   "number": "+16503335555",
18   "number_formatted": "+1 650-333-5555",
19   "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
20   "sms_enabled": true,
21   "supports_mms_to_countries": [
22     "CA",
23     "US"
24   ],
25   "supports_sms_to_countries": [
26     "CA",
27     "US"
28   ],
29   "type": "internal",
30   "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
31   "forward_to": "+16502221111",
32   "forward_to_enabled": true,
33   "forward_to_formatted": "+1 650-222-1111",
34   "inbound_ring_duration": 45,
35   "press_1_to_accept": false,
36   "voicemail_greeting_url": "https://s3.amazonaws.com/bucket/aaa-bbb-ccc.mp3"
37 }

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”.
Change how long (in seconds, 15-90) the number rings on inbound calls before moving on (e.g. to voicemail) via inbound_ring_duration.

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". - Change how long (in seconds, 15-90) the number rings on inbound calls before moving on (e.g. to voicemail) via `inbound_ring_duration`.

Authentication

AuthorizationBasic

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

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

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

carrier_typeenum or null

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

user_idstring or null

forward_tostring or null

forward_to_enabledboolean

forward_to_formattedstring or null

inbound_ring_durationinteger or null

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 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