Skip to main content
PUT
/
v1
/
documents
/
{documentId}
/
permissions
Update document permission 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": "NO_ACCESS",
  "canDownload": true,
  "canDrill": true,
  "canSchedule": true,
  "canUpload": true,
  "canViewWorkbook": true
}
'
{
  "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 document identifier. 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
​
organizationRole
enum<string>

The default content role for the organization. Must be one of:

  • NO_ACCESS - No access. Document won't appear in content system or search results.
  • VIEWER - View dashboard
  • EXPLORER - View and explore dashboard and workbook
  • EDITOR - Edit dashboard and workbook
  • MANAGER - Edit dashboard and workbook and manage permissions
Available options:
NO_ACCESS,
VIEWER,
EXPLORER,
EDITOR,
MANAGER
​
canDownload
boolean

If true, users with required permissions will be able to download the document's query results or dashboards. In the UI, this is the Download setting in the document's settings.

​
canDrill
boolean

If true, users with required permissions will be able to drill into data points in the document's content. In the UI, this is the Drill setting in the document's settings.

​
canSchedule
boolean

If true, users with required permissions will be able to create deliveries (schedules and alerts) on the document. In the UI, this is the Schedule setting in the document's settings.

​
canUpload
boolean

If true, users with required permissions can upload data (ex: CSVs) into the document to create data input tables. In the UI, this is the Upload data setting in the document's settings.

​
canViewWorkbook
boolean

If true, users with required permissions can view a read-only version of the workbook. In the UI, this is the Viewers can see workbook setting in the document's settings.

Response

Settings updated successfully

​
success
boolean
Example:

true