| Page Properties |
|---|
| label | api_docs_clients_addresses |
|---|
|
| Name | Clients / Addresses / Create |
|---|
| Description | Create one or more addresses for an existing client |
|---|
| Type | POST |
|---|
| URL | /v9/clients/:client_id/addresses |
|---|
| Credential Type | API |
|---|
|
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
| | | | Location | Limitations |
|---|
client_id | The ID of the specific Client | Integer | Required | URI |
|
|
label
| Arbitrary description, like 'home' or 'office' | String | Optional | Body | 20 characters max |
name
| Name of the person at this address | String | Optional | Body |
|
|
company
| Company name in the address | String | Optional | Body |
| 50 characters max |
street_address
| Street address of the new address | String | Optional | Body |
|
|
extended_address
| Second line of the street address | String | Optional | Body |
|
|
locality
| City | String | Optional | Body |
|
|
region
| State or province | String | Optional | Body |
|
|
postal_code
| Zip code | String | Optional | Body |
|
|
primary | Indicate that this is the primary address for this client. | Boolean | Optional | Body |
| ...
Examples
|
|---|
|
|
| Code Block |
|---|
| language | ruby |
|---|
| theme | Confluence |
|---|
| collapse | true |
|---|
| {"addresses":[{"company":"Moe\u2019s Tavern","street_address":"555 Evergreen Terrace","locality":"Springfield","region":"MG","postal_code":"58008-0000","country_code":"US","label":"Work"}]} |
| | Code Block |
|---|
| language | ruby |
|---|
| theme | Confluence |
|---|
| collapse | true |
|---|
| {
"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
}
]
} |
|