Skip to main content
PATCH
Update an address

Authorizations

Authorization
string
header
required

OAuth 2.0 Bearer Token from Clerk authentication

Path Parameters

person_id
string
required

The person ID

id
string
required

The address ID

Body

application/json
line1
string
Example:

"456 Oak Ave"

line2
string
Example:

"Apt 2B"

city
string
Example:

"Boulder"

state
string
Example:

"CO"

zip
string
Example:

"80301"

country_code
string
Example:

"US"

address_type
enum<string>
Available options:
home,
work,
mailing,
other
Example:

"work"

is_primary
boolean
Example:

true

Response

address updated

id
string
person_id
string
line1
string
line2
string
city
string
state
string
zip
string
country_code
string | null
address_type
string
is_primary
boolean