Update document permission settings
Update the permission and interactivity settings for a document. For example, the ability to allow users to schedule or download the document’s content.
Note: Only the fields included in the request will be updated.
Authorizations
Can be either an Organization API Key or Personal Access Token (PAT).
Include in the Authorization header as: Bearer YOUR_TOKEN
Path Parameters
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
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 dashboardEDITOR- Edit dashboard and workbookMANAGER- Edit dashboard and workbook and manage permissions
NO_ACCESS, VIEWER, EDITOR, MANAGER If true, users with required permissions can explore from this document by creating new workbooks. In the UI, this is the Analyze in new workbook setting in the document's settings.
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.
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.
If true, users with required permissions can duplicate the document. In the UI, this is the Duplicate setting in the document's Share settings.
If true, users can request access to the document when they don't have permissions to view it. In the UI, this is the Request access setting in the document's settings.
If true, users with required permissions can create spreadsheets from query results. In the UI, this is the Save as spreadsheet setting in the document's settings.
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.
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.
If true, users with required permissions can use AI features within the dashboard. In the UI, this is the Dashboard AI setting in the document's settings.
If true, users can override the document's timezone setting. In the UI, this is the Timezone override setting in the document's settings.
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.
If true, publishing changes to this document requires a pull request through the git integration. In the UI, this is the Require pull request to publish setting in the document's settings.
Response
Settings updated successfully
true