tenancy

POST /v1/orgs/{orgId}/privacy/erasure

Ask for this organization's account to be erased (GDPR Art. 17).

All tenancy endpoints

All developer docs →

Zinn®, our Viking, hammering at his anvil beside an API endpoint sending events to several listeners.

Authentication

Send an API key as a bearer token. This endpoint checks no specific permission, so any key for your organisation can call it.

Where your organisation id goes

This endpoint takes your organisation id in the URL itself, as orgId. Substitute it into the path — there is no header or query parameter that will do instead.

Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X POST https://api.zinndigital.com/v1/orgs/{orgId}/privacy/erasure \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "confirm_name": <string>, "acknowledge": <boolean> }'

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

Double confirmation — confirm_name must equal the organization's name exactly AND acknowledge must be true (422 otherwise) — plus a sign-in from the last five minutes (403 STEP_UP_REQUIRED). Every renewal stops now, so nothing is billed after the request. The erasure runs after the cooling-off period (14 days) unless it is cancelled: the account is closed through the ordinary closure (sites torn down, client orgs re-parented), members who belong to no other org are pseudonymised and deleted from the identity provider, and contact details and free text in every other org-scoped record are overwritten. Invoices, credit notes, payments, orders and subscriptions are tax records and are kept unaltered until retain_until (10 years after the year of the last invoice), as the law requires. An org with an unpaid balance is refused (409). A request already scheduled is returned with 200.

Parameters

NameTypeRequiredWhat it is
orgId (path)UuidYesOrganization ID (UUIDv7).

Request body

NameTypeRequiredWhat it is
confirm_namestringYesThe organization's exact name, typed.
acknowledgebooleanYesMust be true — the second confirmation.

Response

NameTypeRequiredWhat it is
idUuidYesUUIDv7 identifier — sortable by creation time (docs/02 §8).
org_idUuidYesUUIDv7 identifier — sortable by creation time (docs/02 §8).
kindstring<export, erasure>Yes—
statusPrivacyRequestStatusYes—
created_atstringYes—
erase_afterobjectYesErasure only — when the cooling-off period ends and the erasure runs.
completed_atobjectYes—
cancelled_atobjectYes—
expires_atobjectYesExport only — when the archive is deleted.
size_bytesintegerYes—
row_countintegerYes—
table_countintegerYes—
retain_untilobjectYesErasure only — the last day the retained tax records are kept.

Errors this endpoint can return

401 · 403 · 404 · 409 · 422 · 429 · 503