Versions Compared

Old Version 8

changes.mady.by.user J Cobb

Saved on

compared with

New Version 9

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 / Index
DescriptionList Addresses for a specified Client
TypeGET
URL
/v9/clients/:client_id/addresses
Credential TypeAPI
Supports PaginationYes

...

Name
Description
Type
Presence
LocationLimitations
client_idThe ID of the specific ClientIntegerRequiredURI 
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

...