...
Page Properties |
---|
label | api_docs_client_actions |
---|
|
Name | Clients / Phone Numbers / Update |
---|
Description | Update an existing phone number for an existing client |
---|
Type | PUT |
---|
URL | /v9/clients/:client_id/phone_numbers/:phone_number_id |
---|
Credential Type | API |
---|
|
Long Description
Update an existing phone number for an existing client.
Info |
---|
Starting 3/23/2015 You can send number as area_code and number e.g. {:area_code => "212", :number => "5551212" }. the old way {number => "(212) 555 1212"} is still supported, but will be depreciated in the new api release. |
Parameters
| | | | Location | Limitations |
---|
client_id | The ID of the specific Client | Integer | Required | URI |
|
|
phone_number_id | The ID of the specific Phone Number | Integer | Required | URI |
area_code | The area code | String | Optional | Body | 4 chars max |
|
number | The phone number | String | Required | Body |
|
|
extension | Specific extension | String | Optional | Body |
|
|
label | A label to associate with this phone number | String | Optional | Body | 20 characters max |
Examples
Request | Response |
---|
/v9/clients/:client_id/phone_numbers/:phone_number_id |
|
|
Code Block |
---|
language | ruby |
---|
theme | Confluence |
---|
| {
"label": "Work",
"country_code": "+1",
" |
|
area_code",
"number": ") 555-1212",
"extension": " |
|
12 |
Code Block |
---|
language | ruby |
---|
theme | Confluence |
---|
| {
"phone_numbers":[
{
"label":"Work",
"number":"(504) 555-1212",
"country_code":"+1",
"extension":"71",
"updated_at":"2014-02-05T16:00:48Z",
"url":"/clients/109402/phone_numbers/145996",
"id":"145996"
}
]
} |
|