Uwierzytelnianie
Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie org.delete; klucz bez niego jest odrzucany z kodem 403, a nie 404.
Miejsce na identyfikator organizacji
Ten punkt końcowy pobiera identyfikator Twojej organizacji bezpośrednio z adresu URL jako orgId. Podstaw go w ścieżce — nie ma nagłówka ani parametru zapytania, które mogłyby go zastąpić.
Identyfikator Twojej organizacji znajduje się na ekranie kluczy API w Twoim panelu, obok samego klucza. Jest to ten sam identyfikator w każdym wywołaniu, które wykonujesz.
Wypróbuj
Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.
curl -X DELETE https://api.zinndigital.com/v1/orgs/{orgId} \
-H "Authorization: Bearer zdk_live_…"Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API
Szczegóły
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.
Parametry
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
orgId (path) | Uuid | Tak | Organization ID (UUIDv7). |
Odpowiedź
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
org_id | Uuid | Tak | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
sites_torn_down | Uuid[] | Tak | — |
orgs_reparented | Uuid[] | Tak | — |
domains_retained | Uuid[] | Tak | — |
failures | string[][] | Tak | [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… |
Błędy, które ten punkt końcowy może zwrócić
401 · 403 · 404 · 409 · 429