Archive (soft-delete) an org (owner)

DELETE

/v1/admin/orgs/{org_id}

• Production
• Local

Soft-deletes (archives) the org. Guarded: an org with active child orgs or active projects cannot be archived. The compatibility customers row is never hard-deleted.

Authorizations

• ClerkSession

Parameters

Path Parameters

org_id

required

string

Responses

200

Archived.

An Extrovert organization (the authority/billing boundary). org ids are plain server-created UUIDs (never client-supplied). A root org has a null parent_org_id; child orgs reference their parent.

object

id

required

string

customer_id

required

string

parent_org_id

string

nullable

root_org_id

required

string

display_name

required

string

slug

required

string

lifecycle_status

required

string

Allowed values: active archived deleted

plan_tier

required

string

max_child_orgs

required

integer

max_projects

required

integer

version

required

Optimistic-CAS version.

integer

created_at

required

string format: date-time

updated_at

required

string format: date-time

401

Missing or invalid credential.

The canonical error envelope. error is a stable machine code.

object

error

required

Stable error code (e.g. unauthorized, forbidden, not_found, invalid, quota_exceeded, rate_limited).

string

Example

forbidden

message

Human-readable detail (never leaks internals).

string

Example

missing required scope

403

Authenticated but lacking the required scope, or out of quota.

The canonical error envelope. error is a stable machine code.

object

error

required

Stable error code (e.g. unauthorized, forbidden, not_found, invalid, quota_exceeded, rate_limited).

string

Example

forbidden

message

Human-readable detail (never leaks internals).

string

Example

missing required scope

404

Resource not found.

The canonical error envelope. error is a stable machine code.

object

error

required

Stable error code (e.g. unauthorized, forbidden, not_found, invalid, quota_exceeded, rate_limited).

string

Example

forbidden

message

Human-readable detail (never leaks internals).

string

Example

missing required scope

409

Resource conflict (e.g. a duplicate entry).

The canonical error envelope. error is a stable machine code.

object

error

required

Stable error code (e.g. unauthorized, forbidden, not_found, invalid, quota_exceeded, rate_limited).

string

Example

forbidden

message

Human-readable detail (never leaks internals).

string

Example

missing required scope