Skip to main content
PATCH
Update a payer profile
A field left out keeps its value, and null clears it.

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

Body

application/json
name
string | null

null clears it

Required string length: 1 - 200
given_name
string | null

null clears it

Required string length: 1 - 100
family_name
string | null

null clears it

Required string length: 1 - 100
email
string | null

null clears it

Required string length: 1 - 254
Pattern: ^[^\s@]+@[^\s@]+$
phone
string | null

null clears it

Required string length: 1 - 40
billing_address
object | null

null clears it

Response

The changed payer profile

id
string
required

payer_ and 32 lowercase hex digits

Pattern: ^payer_[0-9a-f]{32}$
external_user_id
string | null
required

The end user's ID in a Business account; null for a Personal account's profile

name
string | null
required
given_name
string | null
required
family_name
string | null
required
email
string | null
required
phone
string | null
required
billing_address
object | null
required
addresses
object[]
required

Its shipping addresses, oldest first

created_at
string
required

a string to be decoded into a Date

updated_at
string
required

a string to be decoded into a Date