Skip to main content
PATCH
/
v1
/
documents
/
{documentId}
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"
}

Authorizations

​
Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

​
documentId
string
required

Document identifier

Body

application/json
​
name
string

New name for the document.

Required string length: 1 - 255
​
description
string

Updated description of the document. Set as null to clear the description.

Maximum string length: 1024
​
clearExistingDraft
boolean

If true, discards any existing draft before renaming.

Note: This parameter is required when a draft exists for the document.

​
identifier
string

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"

Response

Document renamed successfully

​
identifier
string

The document identifier

​
name
string

The new document name