---
title: "Archive folders"
method: POST
path: "/folders:archive"
tags: ["folders"]
---

# Archive folders

`POST /folders:archive`

## Request

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

Archives folders and their contents

## Request body

- FoldersArchive
  - `folderIds` string[], required: A list of folder IDs to archive.
  - `reason` 'Made in error' | 'Retired' | 'Other', required: The reason for archiving the provided folders. Accepted reasons may differ based on tenant configuration.

## Response `200`

OK

- FoldersArchivalChange: IDs of all items that were archived or unarchived, grouped by resource type. This includes the IDs of folders along with any IDs of folder contents that were unarchived.
  - `aaSequenceIds` string[]
  - `customEntityIds` string[]
  - `dnaSequenceIds` string[]
  - `entryIds` string[]
  - `folderIds` string[]
  - `mixtureIds` string[]
  - `oligoIds` string[]
  - `protocolIds` 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)