Sign in

v4

latestOpenAPI 3.1.02026-08-01207318738.7 KB
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)

Request body

canAnalyzeboolean

Allow exploring from this document

canDownloadboolean

Allow downloading

canDrillboolean

Allow drill-down

canDuplicateboolean

Allow duplicating

canRequestAccessboolean

Allow requesting access

canSaveSpreadsheetsboolean

Allow creating spreadsheets

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

Response

Permission settings updated successfully

successboolean required

Whether the operation was successful

Example response

{
  "success": true
}