Skip to main content
POST
/
v1
/
documents
/
{documentId}
/
permissions
Grant document permissions
curl --request POST \
  --url https://{instance}.omniapp.co/api/v1/documents/{documentId}/permissions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "role": "VIEWER",
  "accessBoost": true,
  "userIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "userGroups": [
    "<string>"
  ]
}
'
{
  "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

​
documentId
string
required

Document identifier

Body

application/json
​
role
enum<string>
required

Permission role

Available options:
VIEWER,
EDITOR,
MANAGER
​
accessBoost
boolean
required

Enable access boost

​
userIds
string<uuid>[]

User IDs to grant permissions

​
userGroups
string[]

User groups to grant permissions

Response

Permissions granted successfully

​
success
boolean
Example:

true