Edit

[POST] .../v1/folder/edit

Edits folder. Use this method to rename a folder, move it to another parent folder or change its personal/public access level after selecting it with Folder/Get. The request body is required and must include id; name, parent_id and access_level are optional, but at least one editable field must be sent to produce a change. The method rejects system folders, duplicate active names in the target parent, moves into the same folder or a descendant and moves that would make the folder subtree deeper than five levels. The caller must have folder edit permission and write access to the current and target folder context; missing body, invalid id, missing folder, system folder edits, denied permission, unsupported database version, duplicate names, cyclic moves, depth violations, no changed fields and database errors are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
access_level String Optional New access level. Optional and must be personal or public when supplied. Allowed values: system, personal, public.
id Int64 Required Folder ID.
name String Optional New folder name. Optional and limited to 200 characters when supplied.
parent_id Int64 Optional New parent folder identifier. Optional; moving to the current folder or its descendant is rejected.

Request Example

{
  "id": 10,
  "name": "Invoices 2026",
  "parent_id": 1,
  "access_level": "public"
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Update Update operation result.

Response Example

{
  "ok": true,
  "result": {
    "row_affected": 1
  }
}