Skip to main content
PUT
/
v1
/
documents
/
{documentId}
/
permissions
Update document settings
curl --request PUT \
  --url https://{instance}.omniapp.co/api/v1/documents/{documentId}/permissions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "organizationRole": "<string>",
  "organizationAccessBoost": true,
  "canDownload": true,
  "canDrill": true,
  "canSchedule": true,
  "canUpload": true,
  "canViewWorkbook": true
}
'
{
  "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
organizationRole
string
required

Organization-level role

organizationAccessBoost
boolean
required
canDownload
boolean
canDrill
boolean
canSchedule
boolean
canUpload
boolean
canViewWorkbook
boolean

Response

Settings updated successfully

success
boolean
Example:

true