v1

latestOpenAPI 3.1.02026-07-2618690613.4 KB
Documents

Move document

Move a document to new folder or change scope.

put/v1/documents/{documentId}/move

Path parameters

documentIdstring required

The ID of the document to move. To retrieve the ID, navigate to File > Document settings in the document and then click Settings. The Identifier field contains the document ID.

Request body

folderPathstring nullable required

The path of the destination folder. Use null to move the document to the root level (no folder).

scope'organization' | 'restricted'

Optional sharing scope for the document:

  • organization - Organization-wide access
  • restricted - Limited access

If not provided, the scope will be computed based on the document or the destination folder.

Note: When providing a scope, it must match the destination folder's scope.

Response

Document moved successfully

successboolean

Example response

{
  "success": true
}