Sign in

v1

latestOpenAPI 3.1.02026-07-2618690613.4 KB
Document permissions

Update document permissions

Update existing document permissions for users or groups.

patch/v1/documents/{documentId}/permissions

Path parameters

documentIdstring 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.

Request body

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
accessBoostboolean

If true, AccessBoost will be enabled for the document.

userIdsstring[]

The list of user IDs to update permissions for. Use the List users and List embed users endpoints to retrieve user IDs. Either userIds or userGroupIds is required.

userGroupIdsstring[]

The list of user group IDs to update permissions for. Use the List user groups endpoint to retrieve user group IDs. Either userIds or userGroupIds is required.

Response

Permissions updated successfully

successboolean

Example response

{
  "success": true
}