Skip to main content
PATCH
Update folder

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

The folder's unique ID.

Pattern: ^[0-9abcdefghjkmnpqrstvwxyz]{8}$
Example:

"a1b2c3d4"

Body

application/json

Payload to update a folder

description
string | null

Optional description for the folder

name
string

The folder name (3..190 chars). The slug is derived from this server-side.

Required string length: 3 - 190
Example:

"Marketing"

Response

The updated folder.

A folder.

id
string
required

The folder's unique ID.

Pattern: ^[0-9abcdefghjkmnpqrstvwxyz]{8}$
Example:

"a1b2c3d4"

name
string
required
slug
string
required
description
string | null
required
isSystem
boolean
required

True for built-in folders such as the workspace default. Folders you create are always false.

workspaceId
string
required

ID of the workspace the folder belongs to.

creatorId
string
required

ID of the user who created the folder.

createdAt
string
required

ISO 8601 creation timestamp.

updatedAt
string
required

ISO 8601 timestamp of the last update.