> ## Documentation Index
> Fetch the complete documentation index at: https://docs.omni.co/llms.txt
> Use this file to discover all available pages before exploring further.
## Submitting Feedback
If you encounter incorrect, outdated, or confusing documentation on this page, submit feedback:
POST https://docs.omni.co/feedback
```json
{
"path": "/api/document-permissions/update-document-permission-settings",
"feedback": "Description of the issue"
}
```
Only submit feedback when you have something specific and actionable to report.
# Update document permission settings
> Updates the permission and [interactivity settings](/share#controlling-document-interactivity) for a document. For example, the ability to allow users to schedule or download the document's content.
## OpenAPI
````yaml /api/openapi.yaml put /v1/documents/{documentId}/permissions
openapi: 3.1.0
info:
title: Omni API
description: >
The Omni REST API provides programmatic access to your Omni instance for
managing users, documents, queries, schedules, and more.
version: 1.0.0
contact:
name: Omni Support
url: https://docs.omni.co
servers:
- url: https://{instance}.omniapp.co/api
description: Production
variables:
instance:
default: blobsrus
description: Your production Omni instance subdomain
- url: https://{instance}.playground.exploreomni.dev/api
description: Playground
variables:
instance:
default: blobsrus
description: Your playground Omni instance subdomain
security:
- bearerAuth: []
- orgApiKey: []
tags:
- name: AI
description: AI-powered query generation
- name: API Tokens
description: >-
Manage API tokens (Organization keys, Personal Access Tokens, MCP OAuth
grants)
- name: Connections
description: Manage database connections
- name: Connection environments
description: Manage connection environments database connections
- name: Content
description: Unified content retrieval (documents and folders)
- name: Content migration
description: Export and import dashboards
- name: Content validator
description: Validate content against models and perform find/replace operations
- name: Dashboard downloads
description: Download dashboards and tiles as PDF, PNG, XLSX, CSV, or JSON files
- name: Dashboard filters and controls
description: Read and update dashboard filter and control default values
- name: dbt
description: Manage dbt configuration for connections
- name: Documents
description: Create, retrieve, and manage documents
- name: Document favorites
description: Favorite and unfavorite documents
- name: Document labels
description: Apply and manage labels on documents
- name: Document permissions
description: Manage document-level access
- name: Labels
description: >
Manage labels in an organization. Labels can be applied to documents and
folders to help organize and categorize content.
**Label types:**
- **Basic labels**: Can be created and managed by any user
- **Verified labels**: Indicate curated or officially sanctioned content.
Admin-only.
- **Homepage labels**: Appear on the organization homepage. Admin-only.
- name: Folders
description: Create and organize content folders
- name: Folder permissions
description: Manage folder-level access
- name: Jobs
description: Check status of asynchronous jobs
- name: Models
description: Create and manage data models
- name: Model branches
description: Manage model branches and merge changes
- name: Model git configuration
description: Manage git configuration for shared models
- name: Queries
description: Execute workbook queries
- name: Schedules
description: Create and manage scheduled tasks
- name: Schedule recipients
description: Manage schedule recipients
- name: Schema refresh schedules
description: Manage automated schema refresh schedules for connections
- name: Topics
description: Retrieve topic information from models
- name: Uploads
description: Manage file uploads
- name: Users
description: Manage users
- name: User attributes
description: Manage user attribute definitions
- name: User groups
description: Manage user groups
- name: User model roles
description: Manage model and connection role assignments for users
- name: User group model roles
description: Manage model and connection role assignments for user groups
- name: Uploads
description: Manage CSV and spreadsheet uploads
paths:
/v1/documents/{documentId}/permissions:
put:
tags:
- Document permissions
summary: Update document permission settings
description: >
Updates the permission and [interactivity
settings](/share#controlling-document-interactivity) for a document. For
example, the ability to allow users to schedule or download the
document's content.
operationId: updateDocumentSettings
parameters:
- name: documentId
in: path
required: true
schema:
type: string
description: >
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.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
organizationRole:
type: string
enum:
- NO_ACCESS
- VIEWER
- EDITOR
- MANAGER
description: >
The default content role for the organization. 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
canDownload:
type: boolean
description: >-
If `true`, users with required permissions will be able to
[download the document's query
results](/analyze-explore/point-click-queries#downloading-results)
or [dashboards](/visualize-present/dashboards/download). In
the UI, this is the **Download** setting in the document's
settings.
canDrill:
type: boolean
description: >-
If `true`, users with required permissions will be able to
drill into data points in the document's content. In the UI,
this is the **Drill** setting in the document's settings.
canSchedule:
type: boolean
description: >-
If `true`, users with required permissions will be able to
create [deliveries (schedules and
alerts)](/share/deliveries) on the document. In the UI, this
is the **Schedule** setting in the document's settings.
canUpload:
type: boolean
description: >
If `true`, users with required permissions can [upload
data](/analyze-explore/data-input-csvs) (ex: CSVs) into the
document to create data input tables. In the UI, this is the
**Upload data** setting in the document's settings.
canViewWorkbook:
type: boolean
description: >-
If `true`, users with required permissions can view a
read-only version of the workbook. In the UI, this is the
**Viewers can see workbook** setting in the document's
settings.
responses:
'200':
description: Settings updated successfully
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessResponse'
'400':
description: |
Bad Request. Possible causes:
- Invalid parameter value
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
detail: ': Invalid '
status: 400
'403':
description: >
Forbidden. The user sending the API request must have **Manager**
permissions for the document.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
detail: User does not have permission to manage document permissions
status: 403
'404':
description: Document not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
detail: Document with identifier "" not found
status: 404
'429':
$ref: '#/components/responses/TooManyRequests'
security:
- bearerAuth: []
components:
schemas:
SuccessResponse:
type: object
properties:
success:
type: boolean
example: true
Error:
type: object
properties:
error:
type: string
description: HTTP response code for the error
example:
message:
type: string
description: Detailed error description
example:
responses:
TooManyRequests:
description: Too Many Requests - Rate limit exceeded (60 requests/minute)
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: >
Can be either an [Organization API
Key](/api/authentication#organization-api-keys) or [Personal Access
Token (PAT)](/api/authentication#personal-access-tokens-pat).
Include in the `Authorization` header as: `Bearer YOUR_TOKEN`
orgApiKey:
type: http
scheme: bearer
bearerFormat: JWT
description: >
Requires an [Organization API
Key](/api/authentication#organization-api-keys). Personal Access Tokens
(PATs) are not supported for this endpoint.
Include in the `Authorization` header as: `Bearer ORGANIZATION_API_KEY`
````