Skip to main content
DELETE
Delete a workspace

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspace_id
string
required

Query Parameters

name
string
required

The workspace's current name, typed as confirmation

reason
string
required

Why the resource is being deleted; recorded on the audit row

Required string length: 3 - 500

Response

Successful Response

A hard-deleted workspace and the counts of what cascaded with it.

deleted
boolean
required
reason
string
required
workspace
DeletedResource · object
required

What a delete removed: the row's id and name, for the receipt.

cascaded
Cascaded · object | null