Authentication
Send an API key as a bearer token. The key must carry the org.delete permission; a key without it is refused with 403, not 404.
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 DELETE https://api.zinndigital.com/v1/orgs/{orgId} \
-H "Authorization: Bearer zdk_live_…"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
Closes the account: re-parents its client orgs to Zinn® (D-W15-11), tears every one of its own sites down through the ordinary SiteTeardownWorkflow (so they land in DeletedSite and stay restorable for the whole retention window), and keeps its domains renewing (D-W15-12). It also switches renewal off on every one of the org's own subscriptions and cancels any PayPal agreement, so a closed organization is never charged again: each paid period runs out and the subscription expires, with no refund or proration. Requires org.delete on that org — held by the customer owner and by super_admin, so this is a customer's own decision as well as a staff one. ⛔ An org that owes money is suspended, never torn down (D-W15-13): the balance check runs first, performs the suspension itself, and answers 409. Closing is not a route out of an unpaid invoice. ⛔ Answers 200 with the result, not 204: failures is what says a run was partial and left the org OPEN for a retry, and the counts are what an operator reconciles a vendor invoice against.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
orgId (path) | Uuid | Yes | Organization ID (UUIDv7). |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
org_id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
sites_torn_down | Uuid[] | Yes | — |
orgs_reparented | Uuid[] | Yes | — |
domains_retained | Uuid[] | Yes | — |
renewals_stopped | Uuid[] | Yes | The organization's own subscriptions whose renewal the closure switched off (a PayPal agreement is also cancelled at PayPal). A closed organization is never charged again: the… |
failures | string[][] | Yes | [id, error_class] pairs for sites whose teardown could not be armed and subscriptions whose renewal could not be stopped. ⛔ Non-empty means the org is still OPEN and the… |
Errors this endpoint can return
401 · 403 · 404 · 409 · 429