Documents

Update document permission settings

put/api/v1/documents/{identifier}/permissions

Path parameters

identifierstring required

Document identifier (either document ID or identifier slug)

Example:abc123

Document identifier (either document ID or identifier slug)

canDownloadboolean

Allow downloading

canDrillboolean

Allow drill-down

canScheduleboolean

Allow scheduling

canUploadboolean

Allow uploads

canUseDashboardAiboolean

Allow using dashboard AI

canUseTimezoneOverrideboolean

Allow timezone override

canViewWorkbookboolean

Allow viewing workbook

organizationAccessBoostboolean

Boost organization access

organizationRole'viewer' | 'editor' | 'manager' | 'no_access'

Organization-wide role for the document

requirePullRequestToPublishboolean

Require pull request to publish changes

Permission settings updated successfully

successboolean required

Whether the operation was successful

{
  "success": true
}