Delete a board

Delete a board. This will not delete the generations made on it.

On this page

Who can delete a board
Request
Response
Errors

Deletes the board itself. Deleting takes more than edit access, so a caller who can rename a board cannot always remove it.

DELETEhttps://api2.rundiffusion.com/api/v2/boards/{board_id}

AcceptsOAuth device flowPersonal API Access TokenCompany API Access Token

Who can delete a board

Only the board's owner, or a holder of Can manage everyone's generations and boards (MANAGE_ALL_GENERATIONS).

Request

Headers

AuthorizationstringRequired: Bearer token. This endpoint accepts an OAuth device flow token, a Personal API Access Token, or a Company API Access Token. See Authentication.Authorization: Bearer eyJhbGciOi…

Path parameters

board_idstringRequired: The board to delete.Tq8vNc…

curl -X DELETE https://api2.rundiffusion.com/api/v2/boards/$BOARD_ID \
  -H "Authorization: Bearer $RUNDIFFUSION_TOKEN"

await fetch(`https://api2.rundiffusion.com/api/v2/boards/${boardId}`, {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${process.env.RUNDIFFUSION_TOKEN}`,
  },
});

requests.delete(
    f"{BASE}/boards/{board_id}",
    headers=HEADERS,
)

Response

204 No Content. The board stops appearing in List boards and answers 404 BOARD_NOT_FOUND afterwards.

Generations made on it are not deleted and stay in Library. They keep the board_id of the deleted board, so a saved filter still finds them.

Errors

Status codes

401TOKEN_INVALID: Missing or invalid credential.
403PERMISSION_DENIED: You can see the board but may not delete it. Editing is the looser rule, so this can happen where the same caller's edit succeeds.
404BOARD_NOT_FOUND: No such board, or not one this credential can see.
429RATE_LIMITED: Too many requests. Board writes have a tighter budget than reads. See Rate limits.

View as Markdown

Who can delete a board#

Request#