Update address

Update an address.

This endpoint generates an Address updated event.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required
≥ 1

Account ID

int64
required
≥ 1

Address ID

Body Params

Address entity

string
enum

Address type

Allowed:
string
length ≤ 300

Street, avenue, road, and so on, name.

string
length ≤ 9

Address number as string or integer.

If you enter numeric characters, they are saved in the number address object field.

If you enter any non-numeric characters, all characters are saved in the extended_number address object field.

For example, if you enter "12 A", it gets saved as follows:

  • number = 12
  • extended_number = "12 A"
string
length ≤ 100

Address neighborhood. Some countries use neighborhood in addresses.

string
length ≤ 16

Zip/postal code

string
length ≤ 100

Address city

string
length ≤ 30

Address state

string
length ≤ 30

Address country

boolean

Is address active (true) or not (false). Default is true.

boolean

Is this address the mailing address?

Only one address can have this field set to true.

string
length ≤ 100

Any additional information such as suite, apt., and so on.

custom_fields
object

Key/value field for custom information. (Limited to 1014 bytes.)

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json