Skip to main content
PUT
Update a folder
Update a folder’s metadata — its name and/or its position among its siblings. Both fields are optional; only the fields you send are changed. This endpoint does not move a folder to a different parent. To re-parent a folder, use POST /workspace/move with type: FOLDER. Requires edit access to the folder. Returns 404 if the folder does not exist or belongs to a different deployment.

Authorizations

Authorization
string
header
required

Token authentication. Send Authorization: Bearer <YOUR_TOKEN>.

Path Parameters

deploymentId
number
required
folderId
number
required

Body

application/json

UpdateFolderInput

name
string | null
Maximum string length: 255
position
integer | null

Response

200 - application/json
createdAt
required
deploymentId
integer
required
id
integer
required
name
string
required
position
integer
required
type
enum<string>
required
Available options:
FOLDER,
WORKBOOK,
REPORT
updatedAt
required
createdBy
integer
parentId
integer | null
updatedBy
integer | null