v1

latestOpenAPI 3.1.02026-07-2618690613.4 KB

Documents

Update dashboard document

<Warning> **Deprecated** — Removal scheduled for **July 31, 2026**. Use the [Documents v2 API](/api/documents-v2/create-document) instead. </Warning> <Warning> This endpoint only works with dashboard documents. Workbook-only documents are not supported. </Warning>

Update 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.

put/v1/documents/{documentId}

Path parameters

documentIdstring required

Document identifier

Request body

modelIdstring required

Model ID for query transformation

namestring required

Document name

descriptionstring

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

facetFiltersboolean required

When true, enable facet filters on the dashboard

refreshIntervalinteger nullable required

Auto-refresh interval in seconds. Minimum value must be 60. Use null to disable.

filterConfigobject required

Dashboard filter configuration. Pass {} for no filters.

Each key is a field name and the value is a filter definition object.

filterOrderstring[] required

Order of filters in the filter bar. Pass [] if no filters.

clearExistingDraftboolean

If true, discards any existing draft before updating.

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

Example request

{
  "description": "Total monthly sales. Used in sales review meetings."
}

Response

Document updated successfully

identifierstring

The document identifier

namestring

The updated document name

descriptionstring

The updated document description