v1

latestOpenAPI 3.1.02026-07-26457177.8 KB
User

Request User Address Change

📘

You can place the bearer access_token for a specific user into the Authentication section of this documentation 👉.

🚧

Note: Do not pass empty strings or null values for properties. Instead, do not include the property in the payload.

❗️

Note that only 2 address updates are allowed per User per 120 day period.

This endpoint will allow you to update the address of a User.

post/v1/request_address_change

Request body

address1string required

Address line 1 of the User (PO Boxes are not allowed)

address2string

Address line 2 of the User (PO Boxes are not allowed)

citystring required

City of the User

statestring required

State of the User's address

postal_codestring required

Postal code of the User

countrystring

Two-letter Country code of the User's address (defaults to US if not provided)

Response

Successful response