tenancy
DELETE /v1/orgs/{orgId}
Close an organization.
การยืนยันตัวตน
ส่ง API key ในรูปแบบ 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