Skip to main content
PATCH
Rename or move a folder

Authorizations

Authorization
string
header
required

Workspace-scoped API key, sent as a bearer token. The recommended header. The workspace is implicit in the key and never appears in a URL.

Path Parameters

id
string
required

The folder id, as an earlier response reported it. Always dir_….

Example:

"dir_9f2k1x8b3m7q0v"

Body

application/json

Rename the folder in place. The id and the parent do not change.

name
string
required

New leaf name, which renames the folder in place. Send instead of parentId, never with it.

Example:

"initiatives"

Response

The folder after the change. Its id, and every id below it, is unchanged.

object
enum<string>
required

Type discriminator. Always folder.

Available options:
folder
id
string
required

Stable id. Survives a rename or a move.

Example:

"dir_9f2k1x8b3m7q0v"

name
string
required

Leaf name, without any part of the path.

Example:

"reports"

parentId
string | null
required

The containing folder, or null when this folder sits at the root.

Example:

"dir_4k1n8p2v5m7q0x"

parentPath
string
required

Path of the containing folder. / at the root.

Example:

"/projects"

path
string
required

Live folder location. Changes when the folder moves.

Example:

"/projects/reports"

protected
boolean
required

When true, a change to any file inside this folder goes to review instead of being accepted automatically, however the file itself is flagged.

createdAt
string<date-time>
required

When the folder was created.

Example:

"2026-07-01T09:12:00.000Z"

updatedAt
string<date-time>
required

When the folder was last updated.

Example:

"2026-08-01T14:03:00.000Z"