Skip to main content
PATCH
Change a saved address

Authorizations

Authorization
string
header
required

A member credential in the Authorization: Bearer header: a member session JWT, a portal JWT whose login is linked to a membership in that company, or a member token. The credential alone identifies the member and company.

Path Parameters

id
string<uuid>
required

The saved address's id.

Body

application/json

The fields to change; at least one. Any other field is refused.

address1
string
Required string length: 1 - 255
address2
string | null
Maximum string length: 255
city
string
Required string length: 1 - 255
state
string
Required string length: 1 - 255
postal_code
string
Required string length: 1 - 32
country_code
string

Refused while a live subscription ships to this address; subscription country cannot change.

Pattern: ^[A-Z]{2}$
name
string | null
Maximum string length: 255
phone
string | null
Maximum string length: 64

Response

The saved address after the change.

status
integer
required
data
object
required

One of the member's saved addresses.

meta
object
required

Envelope metadata present on every response.