Need help? Get answers from the docs with Omni's in-app AI! Log in to your Omni instance and open the Omni Agent in the sidebar.
Getting started
curl --request PATCH \
--url https://{instance}.omniapp.co/api/v1/documents/{documentId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"identifier": "sales-dashboard-archived"
}
'{
"identifier": "sales-dashboard-archived",
"name": "Sales Dashboard"
}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 |
curl --request PATCH \
--url https://{instance}.omniapp.co/api/v1/documents/{documentId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"identifier": "sales-dashboard-archived"
}
'{
"identifier": "sales-dashboard-archived",
"name": "Sales Dashboard"
}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.
Authorizations
Can be either an Organization API Key or Personal Access Token (PAT).
Include in the Authorization header as: Bearer YOUR_TOKEN
Path Parameters
Document identifier
Body
New name for the document.
1 - 255Updated description of the document. Set as null to clear the description.
1024If true, discards any existing draft before renaming.
Note: This parameter is required when a draft exists for the document.
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
DocumentIdentifierHistoryentry 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.
"sales-dashboard-archived"
Was this page helpful?