Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

NameClients / Phone Numbers / Update
DescriptionUpdate an existing phone number for an existing client
TypePUT
URL/v9/clients/:client_id/phone_numbers/:phone_number_id
Credential TypeAPI

Long Description

Update an existing phone number for an existing client.

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

Name
Description
Type
Presence
LocationLimitations
client_idThe ID of the specific ClientIntegerRequiredURI 
phone_number_idThe ID of the specific Phone NumberIntegerRequiredURI 
area_codeThe area codeStringOptionalBody4 chars max
numberThe phone numberStringRequiredBody 
country_code
The country calling codeStringOptionalBody 
extensionSpecific extensionStringOptionalBody 
labelA label to associate with this phone numberStringOptionalBody20 characters max

 

Examples

RequestResponse
/v9/clients/:client_id/phone_numbers/:phone_number_id 
{
  "label": "Work",
  "country_code": "+1",
  "area_code": "504",
  "number": "555-1212",
  "extension": "12"
}
{
   "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"
      }
   ]
}
  • No labels