Ask to delete the organization
Platform module
POST/org-deletion-requests/requestorgDeletionRequests.request
The Owner (org.organization.delete) with step-up types the bound org's name and a reason (app.request_org_deletion). The subscription ends, the org is read-only at once, every Owner is told, and the data is deleted after 7 days unless an Owner recovers it. A partner with clients and an org under a legal hold are refused with 422. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.
- Requires the capability org.organization.delete.
- OAuth scopes: org.
- Send an Idempotency-Key header. A replay with the same key returns the original response.
- Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.
Request body: OrgDeletionRequestCreate
| Field | Type | Required | Description |
|---|---|---|---|
| confirm_name | string | Yes | The org's name, typed exactly.Constraints: length 1 to 200 |
| reason | string | Yes | Why the org is deleted.Constraints: length 1 to 20000 |
{
"confirm_name": "Harbor Lights Productions",
"reason": "We are closing down."
}Response 201: OrgDeletionRequest
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the org deletion request. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row. |
| reason | string | Yes | Why the org is deleted, in the Owner's words.Constraints: length 1 to 20000 |
| requested_at | string (date-time) | Yes | When the Owner asked for deletion. |
| recover_until | string (date-time) | Yes | End of the 7-day recovery window. |
| requested_by | string (uuid) | Yes | Identifier of the Owner who asked for deletion. |
| recovered_at | string (date-time) | null | Yes | When an Owner recovered the org. |
| recovered_by | string (uuid) | null | Yes | Identifier of the Owner who recovered it. |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"reason": "We are closing down.",
"requested_at": "2026-10-08T14:30:00Z",
"recover_until": "2026-10-08T14:30:00Z",
"requested_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"recovered_at": "2026-10-08T14:30:00Z",
"recovered_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Code samples
curl -X POST "$XOS_BASE_URL/org-deletion-requests/request" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"confirm_name":"Harbor Lights Productions","reason":"We are closing down."}'const { data } = await xos.orgDeletionRequests.request({
"confirm_name": "Harbor Lights Productions",
"reason": "We are closing down."
});response = xos.org_deletion_requests.request({"confirm_name": "Harbor Lights Productions", "reason": "We are closing down."})xos org-deletion-requests request --data '{"confirm_name":"Harbor Lights Productions","reason":"We are closing down."}'