OMomniapp
Documents

Move document

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

Request

  • Base URL
    https://omniapp.co (the document declares no server; this is the origin it was published from)
  • URL
    https://omniapp.co/api/v1/documents/{identifier}/move
  • Auth
    HTTP bearer

Path parameters

identifierstring required

Document identifier (either document ID or identifier slug)

Example:abc123

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
}

Changes

No recorded changes to this operation across all 97 revisions of this API.