Skip to main content
PATCH
Update a payer address
A field left out keeps its value, and null clears an optional one.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

payer_ and 32 lowercase hex digits

address_id
string
required

addr_ and 32 lowercase hex digits

Body

application/json
name
string | null

null clears it

Required string length: 1 - 200
line1
string

a string at most 200 character(s) long

Required string length: 1 - 200
line2
string | null

null clears it

Required string length: 1 - 200
city
string

a string at most 100 character(s) long

Required string length: 1 - 100
region
string | null

null clears it

Required string length: 1 - 100
postal_code
string

a string at most 20 character(s) long

Required string length: 1 - 20
country
string

the ISO 3166-1 alpha-2 country code, such as US

Pattern: ^[A-Z]{2}$
phone
string | null

null clears it

Required string length: 1 - 40
default
enum<boolean>

Make it the default address. A profile's first address is its default

Available options:
true

Response

The changed address

id
string
required

addr_ and 32 lowercase hex digits

Pattern: ^addr_[0-9a-f]{32}$
default
boolean
required

The address a paying run ships to when it names none

name
string | null
required
line1
string
required
line2
string | null
required
city
string
required
region
string | null
required
postal_code
string
required
country
string
required
phone
string | null
required
created_at
string
required

a string to be decoded into a Date

updated_at
string
required

a string to be decoded into a Date