Skip to main content
PATCH
Update a Payee's Address

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

payee_id
string<uuid>
required
address_id
string<uuid>
required

Query Parameters

user_id
string<uuid> | null

Optional. The unique ID of the user who owns this payee. Omit to look the payee up by its ID within your tenant.

Example:

"b3a9b622-cc63-4d3c-aad6-2d8e29e6f9d4"

Body

application/json

Update a payee address (PATCH — only provided fields change).

The service applies model_dump(exclude_unset=True) so an omitted field is left untouched (including is_default, which carries a default here).

label
string | null
Maximum string length: 120
address_type
string | null
Maximum string length: 30
line1
string | null
Maximum string length: 255
line2
string | null
Maximum string length: 255
city
string | null
Maximum string length: 120
state
string | null
Maximum string length: 120
postal_code
string | null
Maximum string length: 20
phone
string | null
Maximum string length: 40
doc_number
string | null
Maximum string length: 100
doc_type
string | null
Maximum string length: 50
doc_issue_country
string | null
Maximum string length: 10
doc_issue_date
string | null
Maximum string length: 20
doc_due_date
string | null
Maximum string length: 20
doc_issuer
string | null
Maximum string length: 255
is_default
boolean
default:false
country
string | null

Response

Successful Response

status_code
integer
required

HTTP status code for the response.

data
PayeeAddressRead · object
required

Payload or error details.

query_generated_time
integer
required

UTC timestamp (milliseconds since epoch) when response was generated.