Documents

Replace document (full replacement)

Deprecated — use PATCH /api/v2/documents/{identifier}/draft (and the related /draft routes). Scheduled for removal on July 31, 2026 (see the Sunset response header).

Updates a document with the specified identifier. This endpoint performs a full resource replacement — all required fields must be provided and existing query presentations are replaced entirely. Only dashboard documents are supported; analysis documents and documents without an associated dashboard return 400. For published documents, the update goes through a draft/publish workflow automatically; if a draft already exists, the request returns 409 unless clearExistingDraft is set to true.

put/api/v1/documents/{identifier}

Path parameters

identifierstring required

Document identifier (either document ID or identifier slug)

Example:abc123

Document identifier (either document ID or identifier slug)

Request body

clearExistingDraftboolean

Clear existing draft before updating (for published documents with drafts)

descriptionstring nullable

Document description

{"stackTrail":"components:schemas:DocumentsPutBody:properties:documentMetadata","oasType":"schema","type":"unknown","description":"Document presentation metadata"}

facetFiltersboolean required

Enable facet filters

{"stackTrail":"components:schemas:DocumentsPutBody:properties:filterConfig","oasType":"schema","type":"unknown","description":"Filter configuration"}

filterOrderstring[] required

Order of filters

modelIdstring required

Model ID

namestring required

Document name

refreshIntervalinteger nullable required

Auto-refresh interval in seconds

Response

Document replaced successfully