Versions Compared

Key

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


Page Properties
labelapi_docs_clients_addresses


NameClients / Addresses / Create
DescriptionCreate one or more addresses for an existing client
TypePOST
URL
/v9/clients/:client_id/addresses
Credential TypeAPI


...

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 addressStringOptionalBody50 characters max
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
primaryIndicate that this is the primary address for this client.BooleanOptionalBody
is_primary_shippingIndicate that this is the primary shipping address for this client.BooleanOptionalBody
is_primary_billingIndicate that this is the primary billing address for this client.BooleanOptionalBody

...