Skip to main content
DELETE
/
projects
/
{projectId}
Delete a project (two-step; ?confirm=true, ?dryRun=true)
curl --request DELETE \
  --url https://origami.chat/api/v2/projects/{projectId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "confirmationRequired": true,
  "willDelete": {
    "workspaces": 123,
    "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

projectId
string<uuid>
required

The project (child org) id.

Query Parameters

confirm
boolean
default:false

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

dryRun
boolean
default:false

Force the impact preview even when confirm is set.

Response

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

Impact preview returned by DELETE /projects/{projectId} when ?confirm=true is absent (or ?dryRun=true is set). Nothing has been removed.

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