tenancy

DELETE /v1/orgs/{orgId}

Close an organization.

Всички крайни точки в tenancy

Упълномощаване

Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението org.delete; ключ без него се отхвърля с 403, а не с 404.

Където отива идентификаторът на вашата организация

Този краен пункт приема идентификатора на вашата организация директно в URL адреса като orgId. Заменете го в пътя — няма заглавна част или заявков параметър, които да го заместят.

ИД на вашата организация се намира на екрана с API ключове във вашето табло за управление, до самия ключ. Това е същият ИД във всяко заявка, която правите.

Опитайте

Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.

curl -X DELETE https://api.zinndigital.com/v1/orgs/{orgId} \
  -H "Authorization: Bearer zdk_live_…"

Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в 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_idUuidДаUUIDv7 identifier — sortable by creation time (docs/02 §8).
sites_torn_downUuid[]Да
orgs_reparentedUuid[]Да
domains_retainedUuid[]Да
failuresstring[][]Да`[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…

Грешки, които този крайpoint може да върне

401 · 403 · 404 · 409 · 429