tenancy
DELETE /v1/orgs/{orgId}
Close an organization.
Автентифікація
Надішліть ключ API як маркер носія (bearer token). Ключ повинен мати дозвіл org.delete; ключ без нього відхиляється з кодом 403, а не 404.
Де вказується ідентифікатор вашої організації
Ця кінцева точка приймає ідентифікатор вашої організації безпосередньо в URL як orgId. Підставте його в шлях — немає заголовка чи параметра запиту, які б замінили це.
Ідентифікатор вашої організації знаходиться на екрані API-ключів у вашій панелі керування, поруч із самим ключем. Це той самий ідентифікатор у кожному вашому запиті.
Спробувати
Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.
curl -X DELETE https://api.zinndigital.com/v1/orgs/{orgId} \
-H "Authorization: Bearer zdk_live_…"Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API
Деталі
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). 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.
Параметри
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
orgId (path) | Uuid | Так | Organization ID (UUIDv7). |
Відповідь
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
org_id | Uuid | Так | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
sites_torn_down | Uuid[] | Так | — |
orgs_reparented | Uuid[] | Так | — |
domains_retained | Uuid[] | Так | — |
failures | string[][] | Так | [site_id, error_class] pairs for sites whose teardown could not be armed. ⛔ Non-empty means the org is still OPEN and the closure should be retried — it is never silently… |
Помилки, які може повертати ця кінцева точка
401 · 403 · 404 · 409 · 429