Clients / Addresses / Update

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

Credential Type

API

Parameters

Name

Description

Type

Presence

Location

Limitations

client_id

The ID of the specific Client

Integer

Required

URI

 

address_id

The ID of the specific Address

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

 

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

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.
However if the address is in the US or Canada, use the 2 digit code.

postal_code

Zip code

String

Optional

Body

 

country_code

2 digit ISO 3166-1 alpha-2 Country Code

String

Optional

Body

 

Examples

Request

Response