Skip to main content
PUT
/
v1
/
documents
/
{documentId}
/
move
Move document
curl --request PUT \
  --url https://{instance}.omniapp.co/api/v1/documents/{documentId}/move \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "folderPath": "<string>",
  "scope": "organization"
}
'
{
  "success": true
}

Authorizations

​
Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

​
documentId
string
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.

Body

application/json
​
folderPath
string | null
required

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

​
scope
enum<string>

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.

Available options:
organization,
restricted

Response

Document moved successfully

​
success
boolean
Example:

true