Update a customer account

Changes the name, domain or custom field values of the customer account with the given external ID. Only the fields you send change; custom fields you leave out keep their values. The request is all-or-nothing: if a custom field is rejected (422), none of the changes are saved, including name and domain. The external ID itself cannot be changed. External IDs in the path may contain dots (for example refine.com). Do not add a format suffix such as .json to the path: it would be read as part of the ID. Requires the customer_accounts_update permission.

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

External ID of the customer account.

Body Params

Update a customer account

string

Display name of the customer account.

string

Primary domain of the customer account, for example example.com. A leading http:// or https:// and trailing slashes are removed.

custom_fields
object

Values for the marketplace's customer account custom fields, keyed by each field's internal name (for example { "region_customer_account": "Europe" }). A menu field only accepts one of its options, and a multi-select menu accepts an array of options or one string separated by ;. An unknown field, an invalid option, or an array for any other field type rejects the whole request with 422, and nothing is saved.

Responses

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