Skip to main content
PUT
/
v1
/
folders
/
{id}
Update a folder
curl --request PUT \
  --url https://api.example.com/v1/folders/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "parentFolderId": "<string>"
}
'
{
  "depth": 123,
  "id": "<string>",
  "name": "<string>",
  "nbAssociatedContents": 123,
  "parentFolderId": "<string>"
}

Authorizations

​
Authorization
string
header
required

API key starting with sk_. Generate one in Settings > API Keys.

Path Parameters

​
id
string
required

Folder ID.

Body

application/json
​
name
string

New folder name.

Minimum string length: 1
​
parentFolderId
string | null

New parent folder ID (null = move to root).

Response

200 - application/json

Default Response

​
depth
integer
required

Nesting depth (0 = root).

​
id
string
required

Unique identifier of the folder.

​
name
string | null
required

Folder name.

​
nbAssociatedContents
integer
required

Number of contents in this folder.

​
parentFolderId
string | null
required

ID of the parent folder (null = root).