Sign in

v8

latestOpenAPI 3.1.02026-08-08211328765.0 KB
Documents

Move document

put/api/v1/documents/{identifier}/move

Path parameters

identifierstring required

Document identifier (either document ID or identifier slug)

Example:abc123

Document identifier (either document ID or identifier slug)

Request body

folderPathstring nullable required

Destination folder path (null for root)

scope'restricted' | 'organization'

Access scope for the document. Optional: when omitted the destination decides — a move into a folder takes that folder's scope, and a move to the root leaves the document's current scope unchanged. When supplied it must match the destination folder's scope.

Response

Document moved successfully

successboolean required

Whether the operation was successful

Example response

{
  "success": true
}