Skip to main content
DELETE
/
workspaces
/
{workspaceId}
Delete a workspace (two-step; ?confirm=true)
curl --request DELETE \
  --url https://origami.chat/api/v2/workspaces/{workspaceId} \
  --header 'Authorization: Bearer <token>'
{
  "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "confirmationRequired": true,
  "willDelete": {
    "tables": 123,
    "rows": 123
  }
}

Authorizations

Authorization
string
header
required

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

Path Parameters

workspaceId
string<uuid>
required

Query Parameters

confirm
boolean
default:false

Must be true to actually delete. Omit for the impact preview.

Response

The impact preview (unconfirmed) or the delete receipt (confirmed).

Impact preview returned by DELETE /workspaces/{workspaceId} when ?confirm=true is absent. Nothing has been removed.

workspaceId
string<uuid>
required
name
string
required
confirmationRequired
boolean
required
willDelete
object
required