Skip to main content
PATCH
Update folder

Authorizations

x-api-key
string
header
required

API Key for server-to-server authentication. Resolves to the owning organization.

Path Parameters

id
string
required

Folder ID

Body

application/json
name
string

New folder name

parentFolderId
string

New parent folder ID

description
string

New folder description

metadata
object

Updated metadata

Response

200 - application/json

Folder updated successfully

_id
string
required

Folder ID

name
string
required

Folder name

organizationId
string
required

Organization ID

status
enum<string>
required

Folder status

Available options:
active,
deleted
createdAt
string<date-time>
required

Creation date

updatedAt
string<date-time>
required

Last update date

parentFolderId
string | null

Parent folder ID

description
string

Folder description

metadata
object

Folder metadata