> ## 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. # Update document > Updates the name, description, and/or identifier of a document. **Note**: At least one of `name`, `description`, or `identifier` must be provided or the API will return a `Bad Request` error. Renaming a document follows the app's draft/publish workflow: | Document Type | Behavior | |---------------|----------| | **Draft** | Renamed directly | | **Published (no existing draft)** | Creates draft > Renames draft > Publishes draft | | **Published (existing draft, `clearExistingDraft: true`)** | Discards existing draft > Creates new draft > Renames > Publishes | | **Published (existing draft, `clearExistingDraft` not set)** | Returns `409 Conflict` | ## OpenAPI ````yaml /api/openapi.yaml patch /v1/documents/{documentId} 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}: patch: tags: - Documents summary: Update document description: > Updates the name, description, and/or identifier of a document. **Note**: At least one of `name`, `description`, or `identifier` must be provided or the API will return a `Bad Request` error. Renaming a document follows the app's draft/publish workflow: | Document Type | Behavior | |---------------|----------| | **Draft** | Renamed directly | | **Published (no existing draft)** | Creates draft > Renames draft > Publishes draft | | **Published (existing draft, `clearExistingDraft: true`)** | Discards existing draft > Creates new draft > Renames > Publishes | | **Published (existing draft, `clearExistingDraft` not set)** | Returns `409 Conflict` | operationId: renameDocument parameters: - name: documentId in: path required: true schema: type: string description: Document identifier requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 255 description: New name for the document. description: type: string maxLength: 1024 description: >- Updated description of the document. Set as `null` to clear the description. clearExistingDraft: type: boolean description: > If `true`, discards any existing draft before renaming. **Note**: This parameter is required when a draft exists for the document. identifier: type: string description: > New identifier for the document. Renaming the identifier works with published documents and maintains old URLs via automatic redirects. When you change a document's identifier: - Both the workbook and document identifiers are updated in one transaction - A `DocumentIdentifierHistory` entry is created so requests to the old identifier automatically redirect to the new one - Dashboard and document history entries are updated **Format requirements:** - Must match the pattern: lowercase letters, numbers, hyphens, and underscores only - Cannot start or end with a hyphen or underscore - Must be unique across all documents in your organization **Common use case:** Migrating content between environments (e.g., staging → production) while maintaining specific identifiers. example: sales-dashboard-archived examples: renameIdentifier: summary: Rename document identifier only value: identifier: sales-dashboard-archived updateNameAndIdentifier: summary: Update both name and identifier value: name: Q2 2026 Sales Report identifier: q2-sales-report renameName: summary: Rename document name only value: name: Updated Dashboard Name responses: '200': description: Document renamed successfully content: application/json: schema: type: object properties: identifier: type: string description: The document identifier name: type: string description: The new document name examples: renameIdentifier: summary: Rename document identifier value: identifier: sales-dashboard-archived name: Sales Dashboard updateNameAndIdentifier: summary: Update both name and identifier value: name: Q2 2026 Sales Report identifier: q2-sales-report '400': description: > Bad Request. Possible causes: - Request body must have `name`, `description`, or `identifier` - Name exceeds 255 characters - Description exceeds 1024 characters - Identifier format is invalid (must be lowercase letters, numbers, hyphens, and underscores; cannot start/end with hyphen or underscore) - Identifier is already in use by another document - Draft already exists - set clearExistingDraft to true to discard it and proceed content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: User has insufficient permissions to update document content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Document not found content: application/json: schema: $ref: '#/components/schemas/Error' '405': $ref: '#/components/responses/MethodNotAllowed' '409': description: > Conflict. Published document has an existing draft and `clearExistingDraft` is not set to `true`. content: application/json: schema: $ref: '#/components/schemas/Error' '429': $ref: '#/components/responses/TooManyRequests' security: - bearerAuth: [] components: schemas: Error: type: object properties: error: type: string description: HTTP response code for the error example: message: type: string description: Detailed error description example: responses: MethodNotAllowed: description: Method Not Allowed - Invalid HTTP method for this endpoint content: application/json: schema: $ref: '#/components/schemas/Error' 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` ````