Versions Compared

Old Version 5

changes.mady.by.user J Cobb

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_addresses
NameClients / Addresses / Update
DescriptionUpdate an existing Address for an existing Client
Type
POST
PUT
URL
/v9/clients/:client_id/addresses/:address_id
Credential TypeAPI

Parameters

Name
Description
Type
Presence
LocationLimitations
client_idThe ID of the specific ClientIntegerRequiredURI
 

address_idThe ID of the specific AddressIntegerRequiredURI
 

label
Arbitrary description, like 'home' or 'office'StringOptionalBody20 characters max
name
Name of the person at this addressStringOptionalBody
 

company
Company name in the addressStringOptionalBody
 

street_address
Street address of the new addressStringOptionalBody
 

extended_address
Second line of the street addressStringOptionalBody
 

locality
CityStringOptionalBody
 

region
State or provinceStringOptionalBody
 

postal_code
Zip codeStringOptionalBody
 

country_code
2 digit ISO 3166-1 alpha-2 Country CodeStringOptionalBody
 

Examples

RequestResponse
 

Code Block
language
code
ruby
themeConfluence
language
ruby
collapsetrue
{"company":"Uncle Moe\u2019s Family Feed-Bag","extended_address":"Next to King Toot\u2019s","label":"Work (and home)","name":"Moe Szyslak"}
Code Block
languageruby
themeConfluence
languageruby
collapsetrue
{
   "country_code":"US",
   "url":"/clients/1625/addresses/46686",
   "updated_at":"2012-01-06T02:47:43Z",
   "longitude":null,
   "street_address":"555 Evergreen Terrace",
   "name":"Moe Szyslak",
   "locality":"Springfield",
   "label":"Work (and home)",
   "id":"46686",
   "latitude":null,
   "postal_code":"58008-0000",
   "region":"MG",
   "extended_address":"Next to King Toot’s"
}