tenancy

DELETE /v1/orgs/{orgId}

Close an organization.

Minden tenancy végpont

Az összes fejlesztői dokumentáció

Hitelesítés

Küldjön egy API-kulcsot bearer tokenként. A kulcsnak rendelkeznie kell a(z) org.delete jogosultsággal; az ezzel nem rendelkező kulcsok esetén a rendszer 403-as hibát ad vissza 404 helyett.

A szervezet azonosítójának helye

Ez a végpont magában az URL-ben várja a szervezeted azonosítóját, mégpedig orgId formában. Helyettesítsd be az útvonalba – nincs olyan fejléc vagy lekérdezési paraméter, amely ezt helyettesítené.

A szervezeted azonosítója a vezérlőpult API-kulcsok képernyőjén található, közvetlenül a kulcs mellett. Ez ugyanaz az azonosító minden indított hívásban.

Próbálja ki

Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.

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

Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban

Részletek

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.

Paraméterek

NévTípusKötelezőMi ez
orgId (path)UuidIgenOrganization ID (UUIDv7).

Válasz

NévTípusKötelezőMi ez
org_idUuidIgenUUIDv7 identifier — sortable by creation time (docs/02 §8).
sites_torn_downUuid[]Igen
orgs_reparentedUuid[]Igen
domains_retainedUuid[]Igen
failuresstring[][]Igen[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…

Hibák, amelyeket ez a végpont visszaadhattatlan

401 · 403 · 404 · 409 · 429