Sign in
latestOpenAPI 3.1.02026-08-211061591.1 MB

69a962f1578f

Folders

Update Folder

Update an existing folder.

post/api/v1/folders/{folder_id}

Path parameters

folder_idinteger required

ID of the folder to update.

Example:1234

Request body

namestring nullable

Updated folder name. Passing null or omitting this field will leave it unchanged.

default_orderinteger nullable

Updated default position of the folder. Passing null or omitting this field will leave it unchanged.

Example request

{
  "name": "Design",
  "default_order": 1
}

Response

Successful Response

idstring required

String ID of the folder.

namestring required

Folder name.

workspace_idstring required

String ID of the workspace that contains the folder.

default_orderinteger required

Default position of the folder in the workspace.

child_orderinteger required

User-specific position of the folder.

is_deletedboolean required

Whether the folder is deleted.

Example response

{
  "id": "1234",
  "name": "Design",
  "workspace_id": "123456",
  "default_order": 1,
  "child_order": 1
}