---
title: "Update document permission settings"
method: PUT
path: "/v1/documents/{documentId}/permissions"
tags: ["Document permissions"]
---

# Update document permission settings

`PUT /v1/documents/{documentId}/permissions`

Update the permission and [interactivity settings](/share#controlling-document-interactivity) 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.

## Path parameters

- `documentId` string, required

## Request body

- object
  - `organizationRole` 'NO_ACCESS' | 'VIEWER' | 'EDITOR' | 'MANAGER' — 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 - `EDITOR` - Edit dashboard and workbook - `MANAGER` - Edit dashboard and workbook and manage permissions
  - `canAnalyze` boolean — 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.
  - `canDownload` boolean — If `true`, users with required permissions will be able to [download the document's query results](/analyze-explore/point-click-queries#downloading-results) or [dashboards](/visualize-present/dashboards/download). 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.
  - `canDuplicate` boolean — If `true`, users with required permissions can duplicate the document. In the UI, this is the **Duplicate** setting in the document's Share settings.
  - `canRequestAccess` boolean — 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.
  - `canSaveSpreadsheets` boolean — 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.
  - `canSchedule` boolean — If `true`, users with required permissions will be able to create [deliveries (schedules and alerts)](/share/deliveries) 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](/analyze-explore/data-input-csvs) (ex: CSVs) into the document to create data input tables. In the UI, this is the **Upload data** setting in the document's settings.
  - `canUseDashboardAi` boolean — 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.
  - `canUseTimezoneOverride` boolean — If `true`, users can override the document's timezone setting. In the UI, this is the **Timezone override** 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.
  - `requirePullRequestToPublish` boolean — 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 `200`

Settings updated successfully

- SuccessResponse
  - `success` boolean

## Other responses

- `400` — Bad Request. Possible causes: - Invalid parameter value
- `403` — Forbidden. The user sending the API request must have **Manager** permissions for the document.
- `404` — Document not found
- `429` — Too Many Requests - Rate limit exceeded (60 requests/minute)

---

[API](https://skmtc.net/omni/apis/omni-api.md) · [All operations](https://skmtc.net/omni/apis/omni-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/omni/omni-api/revisions/6b02f7349d0e/schema)