Order API - Anonymize Customer

Anonymize customer

Endpoint: PUT *base*/anonymize-customer/*customerId*
Authentication: API Key

This endpoint will anonymize all personal data for a customer identifed by the customer id.

This is irrevocable. Personal data will be permanently deleted. This may include financial data. Invoices due to legal requirements will NOT be anonymized.

Parameters

customerId
int
required
b2b b2c

The customerID from :ref:List customers <order-api-list-customers>.

Request example

PUT <base>/anonymize-customer/123 HTTP/1.1

Response

200 Content-type: application/json

status
string
required

ok if success, else no.

msg
string
optional

The response if the anonymization was successful or an error if status is no.

Response example

{
  "status": "ok",
  "msg": "The personal data has been anonymized."
}

Error example

If the customer was not found:

{
  "status": "no",
  "msg": "The customer was not found."
}

If the customer was already anonymized:

{
  "status": "no",
  "msg": "The personal data was already anonymized."
}