Skip to main content
POST
Close the workspace

Authorizations

hookie_session
string
cookie
required

The console's sealed session cookie, set by WorkOS AuthKit. Mutating requests also require the X-Requested-With CSRF header.

Headers

Idempotency-Key
string

Makes a POST safe to retry for 24 hours: the same key, credential, path and body returns the stored response (Idempotent-Replayed: true) instead of running again. 422 if the key was used for a different request; 409 while the first is in flight.

Required string length: 1 - 255

Body

application/json
confirm
string
required

The workspace slug (workspaceSlug on /me), typed back.

Response

Closing.

ok
boolean
required
status
string
required
Allowed value: "suspended"
closure
object
required
subscription_cancelled
boolean
required