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

# Update document permissions

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

Update existing document permissions for users or groups.

## Path parameters

- `documentId` string, required

## Request body

- object
  - `role` 'NO_ACCESS' | 'VIEWER' | 'EDITOR' | 'MANAGER', required — The content role to assign. 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
  - `accessBoost` boolean — If `true`, AccessBoost will be enabled for the document.
  - `userIds` string[] — The list of user IDs to update permissions for. Use the [List users](/api/users/list-users) and [List embed users](/api/users/list-embed-users) endpoints to retrieve user IDs. **Either `userIds` or `userGroupIds` is required.**
  - `userGroupIds` string[] — The list of user group IDs to update permissions for. Use the [List user groups](/api/user-groups/list-user-groups) endpoint to retrieve user group IDs. **Either `userIds` or `userGroupIds` is required.**

## Response `200`

Permissions updated successfully

- SuccessResponse
  - `success` boolean

## Other responses

- `400` — Bad Request. Possible causes: - Missing `userIds` or `userGroupIds` parameter - Invalid `userId` 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)