Save customer billing address

Create or updates (on the user's latest row) the billing address for user_id. The stored name comes from the user's person firstname + lastname (client-supplied names are ignored). Side effect: when you supply signup_business_id and that signup business has update_address_user_notify = 1, the linked store's location-account company address (phone/address/city/zip) is synced to the same values.

Auth

  • Bearer account / partner token. user_id validated by an ownership check (must be in the caller's hierarchy).

Rate limit

  • No rate limit.

Body

FieldTypeRequiredNotes
user_idintegerRequiredMust be an existing user and must belong to caller's hierarchy (an ownership check).
companystringRequiredmax:255; no angle brackets (NameNoAngleBrackets). Stored as company_name.
billing_emailstringRequiredValid email (email:rfc,dns). Stored as email.
mobilestringOptionalmax:20. Stored as phone.
billing_addressstringRequiredmax:255; no angle brackets. Stored as address.
zipcodestringRequiredmin:3, max:10. Stored as postal_code.
city_idintegerRequiredMust be an existing city.
signup_business_idintegerOptionalMust be an existing record. When set and its update_address_user_notify = 1, syncs the store's company address.

Behaviour

  • 200{ data: {.} } with the persisted BillingAddress model (fields: email, phone, postal_code, address, company_name, id, timestamps).
  • 422 — validation failure (invalid email, out-of-scope user_id, angle brackets in text fields, etc.).
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
string
string
string
string
string
string
string | null
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json