---
title: "Update folder"
method: PATCH
path: "/v1/folders/{folderId}"
tags: ["Folders"]
---

# Update folder

`PATCH /v1/folders/{folderId}`

<Note>
  This endpoint requires [**Editor** permissions or higher](/share#content-access-permissions) on the folder being updated.
</Note>

Update a folder's name and/or path segment. Either or both fields can be updated in a single request.

## Path parameters

- `folderId` string, uuid, required

## Request body

- object
  - `name` string — The new display name for the folder. Leading and trailing whitespace is automatically trimmed. At least one of `name` or `path` must be provided.
  - `path` string — The new URL path segment for the folder, which will automatically be converted to lowercase. When a folder's path is updated, all descendant folder paths are automatically updated. To be valid, path segments: - Can contain only alphanumeric characters and dashes - Cannot use reserved names: `favorite`, `labels`, `move`, `share`, `transfer`. Folder names may include these words, but the name cannot be only this word. For example, `favorite` is invalid but `my-favorite` is not. At least one of `name` or `path` must be provided.
  - `resolvePathConflict` boolean — When `true`, automatically resolves path conflicts by appending a numeric suffix (e.g., `blob-sales-2`). When `false` (default), returns a `409 Conflict` error if the path already exists.
  - `breadcrumbRoot` boolean — When `true`, breadcrumbs for this folder and its descendants start at this folder, hiding ancestor folders and the scope crumb (`Shared`, `<name>'s Documents`) Omitting this field leaves the current setting unchanged. Setting it to `false` or `null` explicitly clears the breadcrumb root setting.

## Response `200`

Folder updated successfully

- object
  - `id` string, uuid — Unique identifier for the folder
  - `name` string — Display name of the folder
  - `path` string — Full path to the folder
  - `breadcrumbRoot` boolean — Whether breadcrumbs start at this folder

## Other responses

- `400` — Bad Request Possible error messages: - `At least one of 'name' or 'path' must be provided` - `Path cannot be one of the reserved names: favorite, labels, move, share, transfer` - `Path must contain only alphanumeric characters and dashes` - Invalid JSON or validation errors
- `403` — Forbidden Possible error messages: - Permission denied. Authenticating user must have **Edit** permissions on the folder.
- `404` — Not Found Possible error messages: - `Folder with id <folderId> does not exist`
- `409` — Conflict Returned when `resolvePathConflict=false` (default) and the requested path already exists in the parent folder. Possible error messages: - `A folder with path '<path>' already exists at this location`
- `429` — Too Many Requests - Rate limit exceeded (60 requests/minute)

---

[API](https://skmtc.net/omni/apis/omni-api.md) · [All operations](https://skmtc.net/omni/apis/omni-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/omni/omni-api/revisions/6b02f7349d0e/schema)
