v4

latestOpenAPI 3.1.02026-08-01207318738.7 KB

Documents

Remove dashboard from document

Remove the dashboard from an existing draft, leaving a workbook-only document. Its schedules are removed too, but at publish time (see below), not on this call. Parity with the UI’s "Remove dashboard" action, and the inverse of adding a dashboard via a containers patch.

Operates only on the draft named by draftIdentifier, which the caller creates first via PATCH …/draft. Requiring an explicit draft keeps the removal from silently reusing (and clobbering) a draft that holds other unpublished work.

No auto-publish — publish via POST …/draft/publish to make the document workbook-only (publishing also clears the previously-published dashboard’s schedules). Idempotent: a draft that is already workbook-only returns 200 unchanged.

delete/api/v2/documents/{identifier}/draft/{draftIdentifier}/dashboard

Path parameters

draftIdentifierstring required

Draft workbook identifier (see PATCH /api/v2/documents/{identifier}/draft).

Example:def456

Draft workbook identifier (see PATCH /api/v2/documents/{identifier}/draft).

identifierstring required

Published document identifier.

Example:abc123

Published document identifier.

Response

Dashboard removed on the draft (or a no-op when already workbook-only); the response carries the draftIdentifier.

descriptionstring nullable required

Document description.

draftIdentifierstring required

Identifier of the draft the patch was applied to.

identifierstring required

Published document identifier the draft targets.

namestring required

Document name.