> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getaptly.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Archive a board

> 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.




## OpenAPI

````yaml /openapi.yaml delete /api/board/{boardId}
openapi: 3.0.3
info:
  title: Aptly API
  version: '1.1'
  description: |
    The Aptly API lets external systems work with boards, contacts, inboxes,
    tasks, files, and other Aptly resources.

    Most endpoints accept an API key in the `x-token` header. Some endpoints
    also accept a delegate token or partner bearer token, as shown in each
    operation's security requirements, and explicitly public endpoints require
    no credential. API keys are scoped to a company and may be restricted to
    specific boards and read, insert, or update permissions; requests outside
    those restrictions receive a 403 `FORBIDDEN` response.
servers:
  - url: https://core-api.getaptly.com
    description: Production
security:
  - ApiKeyHeader: []
paths:
  /api/board/{boardId}:
    delete:
      tags:
        - Board
      summary: Archive a board
      description: >
        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.
      operationId: archiveBoard
      parameters:
        - name: boardId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Board archived.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      uuid:
                        type: string
                      archived:
                        type: boolean
                      cardsArchived:
                        type: integer
                        description: >-
                          Cards archived by this call (cards that were already
                          archived aren't counted).
        '401':
          description: Invalid or missing API key.
        '403':
          description: >-
            The key lacks `update` permission or "Edit Boards" access, or the
            board isn't API-enabled.
        '404':
          description: Board not found (or already archived).
      security:
        - ApiKeyHeader: []
        - PartnerBearer: []
components:
  securitySchemes:
    ApiKeyHeader:
      type: apiKey
      in: header
      name: x-token
    PartnerBearer:
      type: http
      scheme: bearer
      description: 'Partner token. Format: `Authorization: Bearer <token>`'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.