Skip to main content
DELETE
Delete the caller's workspace

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

X-Test-Mode
enum<string>

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

Available options:
true,
false

Path Parameters

id
string
required

The organization id. Must equal the caller's own organization.

Body

application/json
confirm
enum<string>
required

Literal confirmation guard — must be the string "DELETE".

Available options:
DELETE

Response

The deletion summary in the standard { data, meta } envelope.

The deletion summary in the standard { data, meta } envelope.

data
object
meta
object