Skip to navigation
Customers

Update a customer

View as Markdown

Details, or active to approve / lock. Requires customers:write.

Authentication

AuthorizationBearer

An API key from the store's admin: חנות > API ומפתחות. Send it as Authorization: Bearer coi_sk_... (or X-Api-Key: coi_sk_...). Never in the URL - ?apikey= is refused with 400.

Path parameters

idintegerRequired

Request

This endpoint expects an object.
emailstringOptional<=150 characters

Required on create. Unique in the store (409 email_taken).

firstNamestringOptional<=50 characters
lastNamestringOptional<=50 characters
phonestringOptional<=50 characters
newsletterbooleanOptional
notesstring or nullOptional
activebooleanOptional

Update only. true approves a pending customer (it is emailed that it can log in) or unlocks one; false locks it out at once.

Response

The updated customer.
oktrueOptional
dataobjectOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error