Clients / Addresses / Update
Name | Clients / Addresses / Update |
|---|---|
Description | Update an existing Address for an existing Client |
Type | PUT |
URL | /v9/clients/:client_id/addresses/:address_id |
API |
Parameters
Name | Description | Type | Presence | Location | Limitations |
|---|---|---|---|---|---|
| The ID of the specific Client | Integer | Required | URI |
|
| The ID of the specific Address | Integer | Required | URI |
|
| Arbitrary description, like 'home' or 'office' | String | Optional | Body | 20 characters max |
| Name of the person at this address | String | Optional | Body |
|
| Company name in the address | String | Optional | Body |
|
| Street address of the new address | String | Optional | Body |
|
| Second line of the street address | String | Optional | Body |
|
| City | String | Optional | Body |
|
| State or province | String | Optional | Body | Adjustable according to the country and can use the country_code in its place, if the country does not commonly have regions in their addresses. |
| Zip code | String | Optional | Body |
|
| 2 digit ISO 3166-1 alpha-2 Country Code | String | Optional | Body |
|
Examples
Request | Response |
|---|---|
| |