Skip to main content
PATCH
Change an address

Authorizations

Authorization
string
header
required

An API key from Settings, API keys. It starts with rc_live_.

Path Parameters

id
string
required

The person's ID.

addressId
string
required

The address's ID.

Body

application/json
label
string | null

Such as Home or Work. Cut to 60 characters.

Maximum string length: 60
address
object

Every part is optional, and a key not listed here is refused. An empty or null part is removed.

notes
string | null

Cut to 500 characters.

Maximum string length: 500
is_primary
boolean

true makes this the primary address.

Response

The address, as it now is.

id
string
required
person_id
string
required
label
string | null
required
address
object
required

Every part is optional, and a key not listed here is refused. An empty or null part is removed.

is_primary
boolean
required
notes
string | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required