---
title: "Update Folder"
method: PATCH
path: "/api/v3/folder/{folder_id}"
tags: ["Folder"]
---

# Update Folder

`PATCH /api/v3/folder/{folder_id}`

## Request

- Base URL: `https://{tenant_name}.benchling.com`
- URL: `https://{tenant_name}.benchling.com/api/v3/folder/{folder_id}`
- Auth: HTTP bearer

Update Folder.

## Path parameters

- `folder_id` string, required

## Request body

- UpdateFolderInput
  - `archiveReason` string: Why it is being archived. Required when `archived` is `true`, and not allowed when unarchiving.
  - `archived` boolean: Set to `true` to archive or `false` to unarchive it. Archiving requires `archiveReason`.
  - `description` string, nullable
  - `name` string

## Response `200`

OK

- Folder: A hierarchical container for organizing entities, notebook entries, and other items within a Project. Folders support nested structures through parent-child relationships (see `parent`), enabling users to create logical groupings that mirror laboratory organization or experimental workflows. Folders belong to a Project (see `project`) and inherit access control through collaborations (see `Collaboration`). Items stored in folders implement the FolderItem interface. Folders can be starred for quick access (via `Starrable`) and archived with lineage tracking that affects contained items (via `ArchivableWithLineage`).
  - `__typename` string
  - `archiveReason` string, nullable
  - `archived` boolean
  - `children` string, uri: The folders directly nested under this folder.
  - `createdAt` string, datetime
  - `description` string, nullable
  - `id` string
  - `modifiedAt` string, datetime, nullable
  - `name` string, nullable
  - `parent` FolderRef
    - `__typename` string
    - `id` string, api_id
  - `project` ProjectRef
    - `__typename` string
    - `id` string, api_id

## Other responses

- `400`: Bad Request
- `403`: Forbidden
- `404`: Not Found
- `409`: Conflict
- `429`: Too Many Requests
- `500`: Internal Server Error

---

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