Versions Compared

Old Version 6

changes.mady.by.user Amanda Steckler

Saved on

compared with

New Version Current

changes.mady.by.user J Cobb

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Page Properties
labelapi_docs_client_actions


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. 

Parameters

Name
Description
Type
Presence
LocationLimitations
client_idThe ID of the specific ClientIntegerRequiredURI
 

phone_number_idThe ID of the specific Phone NumberIntegerRequiredURI
 
area_code
The area codeStringOptionalBody4 chars max
raw_num
The rest of the number after the area codeString
OptionalBody

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
 


Code Block
languageruby
themeConfluence
{
  "label": "Work",
  "country_code": "+1",
  "
area_code
number": "
504", "raw_num": "
(504) 555-1212",
  "extension": "
12
71"
}



Code Block
languageruby
themeConfluence
{
   "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"
      }
   ]
}