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 15 Next »

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

Long Description

Create one or more addresses for an existing client. Note that this takes an array of addresses even if only creating one.

Parameters

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


Examples

RequestResponse

{"addresses":[{"company":"Moe\u2019s Tavern","street_address":"555 Evergreen Terrace","locality":"Springfield","region":"MG","postal_code":"58008-0000","country_code":"US","label":"Work"}]}
{
   "addresses":[
      {
         "country_code":"US",
         "url":"/clients/1625/addresses/46686",
         "updated_at":"2012-01-06T02:44:26Z",
         "longitude":null,
         "street_address":"555 Evergreen Terrace",
         "name":null,
         "locality":"Springfield",
         "label":"Work",
         "id":"46686",
         "latitude":null,
         "postal_code":"58008-0000",
         "region":"MG",
         "extended_address":null
      }
   ]
}
  • No labels