/bff/contact/anonymize

Irreversibly nulls every identifying field on a contact while keeping the row (and its FKs from invoices, orders, etc.) intact. Blocks with HTTP 409 if the contact still has any order in a non-terminal status (new / processing) — the operator must finalise or storno them first so fulfilment is not left without a delivery address. Deletes secondary e-mails, addresses, bank accounts, custom fields, attributes, meta, ARES company records, and password history. Invalidates active sessions. Preserves accounting data: invoices carry an immutable customerSnapshot so historical bookkeeping survives the wipe.

ContactpostBffContactAnonymize

Parameters

2 body

2 total

Body · 2

idstringRequired

Contact external ID.

reasonstringRequired

Free-text reason for the anonymisation. Recorded into shop__contact.deleted_reason and the operator audit feed; minimum 10 chars to discourage empty placeholders.

Length: 10–1000

Request

POST /bff/contact/anonymize

post

curl -X POST "https://api.bizkithub.com/bff/contact/anonymize" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "id": "example_id",
  "reason": "example_reason"
}'

Response

JSON payload

{
  "success": true
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key