Update Customer

Edit the customer profile, contact, address, currency, or external user ID details for an existing customer.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Use this endpoint when you need to change details for a customer you already know.

Provide customer_id as a UUID in the path and send a JSON request body containing the fields you need to change. You can update profile, contact, address, currency, and external user ID details. If your bearer token can access more than one system login, send x-osrs-system-login-id to select the login to use; you can omit this header when exactly one login is available.

A 200 response confirms a successful update. A 422 response indicates that the path, header, or request body did not pass validation.

Path Params
uuid
required
Body Params
length between 1 and 255

External user ID

string
length between 1 and 50
^[^\x00-\x1F\x7F]+$
string
length between 1 and 50
^[^\x00-\x1F\x7F]+$
string
string
length between 1 and 255
^[^\x00-\x1F\x7F]+$
string
length between 1 and 100
^[^\x00-\x1F\x7F]+$
length ≥ 1
^[^\x00-\x1F\x7F]+$
string
length between 2 and 2

2-letter ISO country code

length between 1 and 50
^[^\x00-\x1F\x7F]+$
string
length ≥ 1
Headers

ID (id) of user's login to use for request. Optional if there is exactly one to choose from.

Responses

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