OMomniapp
Documents

Update document permission settings

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

Request

  • Base URL
    https://omniapp.co (the document declares no server; this is the origin it was published from)
  • URL
    https://omniapp.co/api/v1/documents/{identifier}/permissions
  • Auth
    HTTP bearer

Path parameters

identifierstring required

Document identifier (either document ID or identifier slug)

Example:abc123

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. Rejected with 403 when the organization has AccessBoost turned off, or when a user-scoped key lacks boost provisioning.

requirePullRequestToPublishboolean

Require pull request to publish changes

Response

Permission settings updated successfully

successboolean required

Whether the operation was successful

Example response

{
  "success": true
}

Changes

  • b512286a4b08Revision changes
    • breaking

      removed the enum value editor of the request property

    • breaking

      removed the enum value manager of the request property

    • breaking

      removed the enum value no_access of the request property

    • breaking

      removed the enum value viewer of the request property

    • info

      request property list-of-types was widened by adding types null to media type application/json

  • f65b6ea0a62fRevision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property