tenancy

DELETE /v1/orgs/{orgId}

Close an organization.

Semua titik akhir tenancy

Autentikasi

Kirim kunci API sebagai token bearer. Kunci tersebut harus memiliki izin org.delete; kunci tanpa izin tersebut akan ditolak dengan status 403, bukan 404.

Tempat ID organisasi Anda dimasukkan

Endpoint ini menggunakan id organisasi Anda di dalam URL itu sendiri, sebagai orgId. Gantikan ke dalam path — tidak ada header atau parameter kueri yang dapat menggantikannya.

ID organisasi Anda berada di layar kunci API di dasbor Anda, di sebelah kunci itu sendiri. Itu adalah ID yang sama dalam setiap panggilan yang Anda buat.

Coba

Ganti apa pun di dalam tanda kurung sudut dengan nilai Anda sendiri, dan placeholder kunci dengan kunci dari dasbor Anda.

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

Sudah masuk? Konsol API di dasbor Anda akan mengisi ID organisasi asli dan kunci Anda sendiri, serta menjalankan permintaan terhadap API langsung sehingga Anda dapat melihat respons aktualnya. Buka titik akhir ini di konsol API

Detail

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.

Parameter

NamaJenisWajibTentang apa ini
orgId (path)UuidYaOrganization ID (UUIDv7).

Tanggapan

NamaJenisWajibTentang apa ini
org_idUuidYaUUIDv7 identifier — sortable by creation time (docs/02 §8).
sites_torn_downUuid[]Ya
orgs_reparentedUuid[]Ya
domains_retainedUuid[]Ya
failuresstring[][]Ya`[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…

Kesalahan yang dapat dikembalikan oleh titik akhir ini

401 · 403 · 404 · 409 · 429