Skip to main content
PATCH
Rename or move a folder

Authorizations

scribe_session
string
cookie
required

Browser session cookie set by the WorkOS sign-in flow.

Path Parameters

id
string
required

Id of the folder to rename or move.

Body

application/json

Folder fields to update.

Rename and/or move a folder. Omitted fields are left unchanged.

name
string

New folder name.

Required string length: 1 - 200
Example:

"RFCs"

parentId
string | null

New parent folder id, or null to move the folder to the root of its section.

Example:

null

Response

The updated folder.

A folder in the workspace or private sidebar section.

id
string
required

Folder id.

Example:

"fld_7qRsTuVwXyZaBcDeFg3h"

name
string
required

Folder name.

Example:

"Specs"

scope
enum<string>
required

Section the folder lives in: the shared workspace or the owner's private area.

Available options:
workspace,
private
Example:

"workspace"

parentId
string | null
required

Parent folder id, or null at the root of its section.

Example:

null

ownerUserId
string | null
required

Owner of a private folder; null for workspace folders.

Example:

null

createdAt
integer
required

When the folder was created (epoch milliseconds).

Example:

1752624000000

updatedAt
integer
required

When the folder was last renamed or moved (epoch milliseconds).

Example:

1752624000000