ONLYOFFICE DocSpace icon

ONLYOFFICE DocSpace

Consume ONLYOFFICE DocSpace API

Actions35

Folder → Copy Folder

AI-generated

Summary

Copies a folder in ONLYOFFICE DocSpace to a destination room or folder, or to the authenticated user's "My documents" section. It waits for DocSpace's asynchronous copy job to finish and returns the new copied folder.

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 copy.
  • To My Documents (required) — If true, the node looks up the current user's "My documents" folder and uses it as the destination. Default false.
  • Destination ID (required) — Numeric ID of the destination room or folder. Shown and used only when "To My Documents" is false.

Output shape

One JSON item per input item, containing the copied folder object (the first entry of the folders array in the completed copy operation result).

The copy uses conflict resolution 'Duplicate' and does not delete the source. The node polls the file-operations status up to 20 times at 100 ms intervals. It throws on a reported operation error or on timeout. With 'Continue On Fail' enabled, a failed item returns {error: message} instead.

Examples

Example 1: Duplicate a template folder into a project room

Folder ID = 1234, To My Documents = false, Destination ID = 5678 (the room ID).

Example 2: Back up a shared folder into the authenticated user's personal space

Folder ID = 1234, To My Documents = true; Destination ID is not needed.

Links

Discussion