v1

latestOpenAPI 3.0.12026-07-268028223.9 KB
People

Update an address

Update an existing address for a person

patch/v1/people/{person_id}/addresses/{id}

Request body

line1string
line2string
citystring
statestring
zipstring
country_codestring
address_type'home' | 'work' | 'mailing' | 'other'
is_primaryboolean

Example request

{
  "line1": "456 Oak Ave",
  "line2": "Apt 2B",
  "city": "Boulder",
  "state": "CO",
  "zip": "80301",
  "country_code": "US",
  "address_type": "work",
  "is_primary": true
}

Response

address updated

idstring
person_idstring
line1string
line2string
citystring
statestring
zipstring
country_codestring nullable
address_typestring
is_primaryboolean