Skip to main content
PATCH
Set a User's Mailing Address

Authorizations

Authorization
string
header
required

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

Path Parameters

user_id
string<uuid>
required

The unique ID of the user whose mailing address you want to set.

Example:

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

Body

application/json

Set or replace a user's mailing address.

This is the address printed on the shipper/FROM block of a mailed-document (USPS/FedEx) shipping label, used in place of your platform's default collection address once every field here — including mailing_phone, which FedEx requires — is present.

A full replace, not a merge: send every field you want kept on each call. Send an all-null body to clear the address (the label then falls back to the default collection address).

mailing_line_1
string | null
Maximum string length: 255
mailing_line_2
string | null
Maximum string length: 255
mailing_city
string | null
Maximum string length: 120
mailing_state
string | null
Maximum string length: 120
mailing_zip_code
string | null
Maximum string length: 20
mailing_country
string | null

ISO 3166-1 alpha-2 country code, e.g. US.

Required string length: 2
mailing_phone
string | null

Required for the address to be usable on a FedEx label — FedEx rejects a shipment with no shipper phone.

Maximum string length: 40

Response

The user with its updated mailing address.

status_code
integer
required

HTTP status code for the response.

data
PlatformUserRead · object
required

Payload or error details.

query_generated_time
integer
required

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