---
title: "Remove dashboard from document"
method: DELETE
path: "/api/v2/documents/{identifier}/draft/{draftIdentifier}/dashboard"
tags: ["Documents"]
---

# Remove dashboard from document

`DELETE /api/v2/documents/{identifier}/draft/{draftIdentifier}/dashboard`

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.

## Path parameters

- `draftIdentifier` string, required — Draft workbook identifier (see `PATCH /api/v2/documents/{identifier}/draft`).
- `identifier` string, required — Published document identifier.

## Response `200`

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

- DocumentsV2PatchDraftResponse
  - `description` string, nullable, required — Document description.
  - `draftIdentifier` string, required — Identifier of the draft the patch was applied to.
  - `identifier` string, required — Published document identifier the draft targets.
  - `name` string, required — Document name.

## Other responses

- `401` — Authentication required.
- `403` — Insufficient permissions to update the document.
- `404` — Document or draft not found.
- `405` — Method not allowed.
- `409` — The target is not a published document.
- `422` — The document is an app, not a dashboard.

---

[API](https://skmtc.net/omniapp/apis/omni-api.md) · [All operations](https://skmtc.net/omniapp/apis/omni-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/omniapp/omni-api/versions/4701f292c621/schema)