Edit

[POST] .../v1/file/edit

Changes file metadata Use this method to update editable metadata of an existing non-system file after it has been selected with File/Get. The request body is required and must include id; name, access_level, folder_id, width, height and duration_ms are optional, but at least one editable field must be sent. The method can rename a file, change personal/public access, move the file to another writable folder or update render metadata; width and height must be provided together and greater than zero and duration_ms must not be negative. The caller must have file edit permission and either own the file or have permission to work with all files; missing body, invalid id, system file edits, another user's file without access, no changed fields, folder ACL failure, unsupported render metadata database version 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; system files cannot be edited through this endpoint. Allowed values: system, personal, public.
duration_ms Int64 Optional Audio/video file duration in milliseconds. Must be zero or greater when supplied.
folder_id Int64 Optional New file folder identifier. Optional; when supplied, it must point to an existing writable folder.
height Int32 Optional Visual file height in pixels. When supplied, width must also be supplied and both values must be greater than zero.
id Int64 Required File ID.
name String Optional New file name. Optional and limited to 200 characters when supplied.
width Int32 Optional Visual file width in pixels. When supplied, height must also be supplied and both values must be greater than zero.

Request Example

{
  "id": 101,
  "name": "invoice_2026_01_signed.pdf",
  "access_level": "public",
  "folder_id": 12
}

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
  }
}