ONLYOFFICE DocSpace icon

ONLYOFFICE DocSpace

Consume ONLYOFFICE DocSpace API

Actions35

Folder → Move Folder

AI-generated

Summary

Moves a folder in ONLYOFFICE DocSpace to another room or folder, or to the authenticated user's "My documents" section, and returns the moved folder's data.

Inputs

  • Authentication (required) — Credential type used for the request: API Key, Basic Auth, OAuth2 or Personal Access Token. The matching credential must be configured.
  • Folder ID (required) — Numeric ID of the folder to move.
  • To My Documents (required) — If true, the destination is the user's "My documents" root. The node looks up its ID via api/2.0/files/@my. Default is false.
  • Destination ID — Numeric ID of the destination room or folder. It is shown and required only when To My Documents is false.

Output shape

One JSON item per input item, containing the moved folder object (the first entry of the folders array in the completed move operation's result).

The move is a DocSpace async file operation (PUT api/2.0/files/fileops/move). The node polls api/2.0/files/fileops up to 20 times at 100 ms intervals. It throws on any operation error or on timeout. The request uses conflictResolveType "Duplicate" and deleteAfter false, so name conflicts at the destination are duplicated rather than overwritten. With Continue On Fail enabled, a failed item returns {error: message}.

Examples

Example 1: Move a folder into a specific room or folder

Folder ID = 1234, To My Documents = false, Destination ID = 5678.

Example 2: Move a folder into the user's personal space

Folder ID = 1234, To My Documents = true (Destination ID is not used).

Links

Discussion