Skip to navigation

Replace a customer

Every editable field is replaced; fields left out are cleared. The type cannot change, and owner_id must not make the customer its own ancestor.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

customer_idintegerRequired>=1

The customer’s id.

Request

This endpoint expects an object.
namestringRequired1-255 characters
external_idstring or nullOptional<=255 characters
countrystring or nullOptionalformat: "^[A-Z]{3}$"
owner_idinteger or nullOptional>=1
contact_detailsmap from strings to any or nullOptional
billing_detailsmap from strings to any or nullOptional
payout_informationmap from strings to any or nullOptional
settingsmap from strings to any or nullOptional
is_taxable_dealerboolean or nullOptional

Response

The object after the update.
idinteger
organization_idstring
namestring
typeenum or any
is_taxable_dealerboolean
created_atdatetime
updated_atdatetime
external_idstring or nullOptional
countrystring or nullOptional
owner_idinteger or nullOptional
contact_detailsmap from strings to any or nullOptional
billing_detailsmap from strings to any or nullOptional
payout_informationmap from strings to any or nullOptional
settingsmap from strings to any or nullOptional

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
502
Bad Gateway Error
504
Gateway Timeout Error