---
title: "Archive a board"
method: DELETE
path: "/api/board/{boardId}"
tags: ["Board"]
---

# Archive a board

`DELETE /api/board/{boardId}`

## Request

- Base URL: `https://core-api.getaptly.com`
- URL: `https://core-api.getaptly.com/api/board/{boardId}`
- Auth: one of:
  - API key in header `x-token`
  - HTTP bearer
- TypeScript: <https://skmtc.dev/getaptly/apis/aptly-api/docs/api/board/:boardId/delete.ts> (a function with typed inputs; its response is checked against the schema)

Archives the board, as the Archive action in the Aptly app does: the board, all of its cards,
its saved filters and its communication templates are archived, and the cards' open tasks are
closed out. Nothing is hard-deleted, but there is no API to un-archive, and an archived board
stops resolving through the API (404). Requires `update` permission and the key's "Edit
Boards" access.

## Path parameters

- `boardId` string, required

## Response `200`

Board archived.

- object
  - `data` object
    - `uuid` string
    - `archived` boolean
    - `cardsArchived` integer: Cards archived by this call (cards that were already archived aren't counted).

## Other responses

- `401`: Invalid or missing API key.
- `403`: The key lacks `update` permission or "Edit Boards" access, or the board isn't API-enabled.
- `404`: Board not found (or already archived).

---

[API](https://skmtc.dev/getaptly/apis/aptly-api.md) - [All operations](https://skmtc.dev/getaptly/apis/aptly-api/llms.txt) - [OpenAPI document](https://skmtc.dev/getaptly/apis/aptly-api/revisions/75c367e0b8e5?raw)