---
title: "Archive app canvases"
method: POST
path: "/app-canvases:archive"
tags: ["apps"]
---

# Archive app canvases

`POST /app-canvases:archive`

## Request

- Base URL: `https://{tenant_name}.benchling.com/api/v2`
- URL: `https://{tenant_name}.benchling.com/api/v2/app-canvases:archive`
- Auth: HTTP bearer

Archive app canvases

## Request body

- AppCanvasesArchive
  - `canvasIds` string[], required: Array of canvas IDs
  - `reason` 'Other', required: Reason that canvases are being archived. Actual reason enum varies by tenant.

## Response `200`

OK

- AppCanvasesArchivalChange: IDs of all items that were archived or unarchived. This includes the IDs of canvases that were archived / unarchived.
  - `canvasIds` string[]

## Other responses

- `400`: Bad Request

---

[API](https://skmtc.dev/benchling/apis/benchling-api-2.md) - [All operations](https://skmtc.dev/benchling/apis/benchling-api-2/llms.txt) - [OpenAPI document](https://skmtc.dev/benchling/apis/benchling-api-2/revisions/01d2fa8523cd?raw)
