Sign in

v1

latestOpenAPI 3.1.02026-07-2618690613.4 KB
Documents

Update document

<Warning> **Deprecated** — Removal scheduled for **July 31, 2026**. Use the [Documents v2 API](/api/documents-v2/create-document) instead. </Warning>

Update 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 TypeBehavior
DraftRenamed 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
patch/v1/documents/{documentId}

Path parameters

documentIdstring required

Document identifier

Request body

namestring

New name for the document.

descriptionstring

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

clearExistingDraftboolean

If true, discards any existing draft before renaming.

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

identifierstring

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 request

{
  "identifier": "sales-dashboard-archived"
}

Response

Document renamed successfully

identifierstring

The document identifier

namestring

The new document name