Skip to main content
PATCH
Update a folder

Authorizations

Authorization
string
header
required

Workspace credential issued from the automation console at /automation. Send it as Authorization: Bearer vq_ws_.... This is NOT a Data API key: a vq_key_ credential is refused here and names the other product in the error.

Path Parameters

folderId
string
required

fld_ identifier of the folder. Take it from GET /v1/folders.

Body

application/json

Rename a folder, or move it under a different parent.

Two fields, and the omissions are each recorded elsewhere at their own definition site. color and pinned are UI chrome and unpublished on the read model too. matterId is not repatriable: moving a matter folder to a different matter is a reorganization of the customer's work that has no headless meaning, and the web app itself guards it with three separate consistency checks rather than treating it as a field.

A cycle (parentId naming the folder itself or one of its descendants) is refused by the folders_prevent_cycle trigger. This API does not reimplement the web app's 100-step ancestor walk: a second Python copy would be weaker and would still lose a race with a concurrent move.

name
string | null

New display name. Trimmed; whitespace alone is refused. Cannot be set to null.

Required string length: 1 - 100
Example:

"Closing Documents"

parentId
string | null

fld_ identifier of the folder to move this one under. Must belong to your organization. Send null to move it to the root. A cycle is refused by the database.

Example:

"fld_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"

Response

Successful Response

A folder as this API publishes it.

id
string
required

Public identifier, fld_ followed by 32 hex characters.

Example:

"fld_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"

name
string
required

The folder's display name.

Example:

"Closing Documents"

parentId
string | null

fld_ identifier of the containing folder. Absent when the folder sits at the root.

Example:

"fld_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"

matterId
string | null

mat_ identifier when the folder is scoped to one matter. Absent means a workspace-level folder, visible across drafts and chats.

Example:

"mat_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"

createdAt
string<date-time> | null

When the folder was created (RFC 3339).

Example:

"2026-08-19T14:32:10Z"

updatedAt
string<date-time> | null

When the folder was last modified (RFC 3339).

Example:

"2026-08-19T14:32:10Z"

Last modified on August 23, 2026