Trash or delete a board

DELETE /boards/{boardId}

Updated 16 Sep 20261 min read

DELETE/boards/{boardId}Try it

Basehttps://api.mockflow.com/v1Scopesboards:write

Request

curl https://api.mockflow.com/v1/boards/brd_3f9e2a \
  -X DELETE \
  -H "Authorization: Bearer $MOCKFLOW_API_KEY"

const response = await fetch("https://api.mockflow.com/v1/boards/brd_3f9e2a", {
  method: "DELETE",
  headers: {
    Authorization: `Bearer ${process.env.MOCKFLOW_API_KEY}`
  }
});

const data = await response.json();

import os, requests

response = requests.delete(
    "https://api.mockflow.com/v1/boards/brd_3f9e2a",
    headers={"Authorization": f"Bearer {os.environ['MOCKFLOW_API_KEY']}"},
)

response.raise_for_status()
data = response.json()

Response

No body. Trashed, or deleted for good.

{
  "error": {
    "code": "conflict",
    "message": "Basic without permanent=true, or the board is already in the trash.",
    "docsUrl": "https://mockflow.com/developers/concepts/errors#conflict"
  },
  "requestId": "req_45d49816999bac40"
}

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests.",
    "docsUrl": "https://mockflow.com/developers/concepts/errors#rate_limited"
  },
  "requestId": "req_45d49816999bac40"
}

On Plus and Max the board goes to the trash for 30 days. Basic has no trash: the board is deleted for good, and the call insists on ?permanent=true so that cannot happen by accident. ?permanent=true also empties a board out of the trash on any plan.

Authorization

Authorizationstringheaderrequired

Bearer <key>. The key needs boards:write scope. Create and manage keys in the developer console; what each scope unlocks is on the scopes page.

Path parameters

boardIdstringpathrequired

Query parameters

permanentbooleanquery

Defaults to false.

Response

204

No body

Trashed, or deleted for good.

Errors

409conflict

Basic without permanent=true, or the board is already in the trash.

429rate_limited

Too many requests.

Was this page helpful?