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

Authorizations

​
Authorization
string
header
required

Use either an Organization API Key or Personal Access Token (PAT). Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

​
identifier
string
required

Document identifier

Body

application/json
​
folderPath
string | null
required

Destination folder path or null for root

​
scope
enum<string>

Document scope

Available options:
organization,
restricted

Response

Document moved successfully

​
success
boolean
Example:

true