Documents

Remove app from a draft

Changed on

Alpha. The app sub-resource may change shape without a deprecation cycle while apps mature. The document routes are stable.

Remove the app from an existing draft, leaving a workbook-only document — the app-side mirror of DELETE …/dashboard, with the same contract: no body (the route is draft-scoped, so publish stays the checkpoint behind it). Operates only on the draft named by draftIdentifier; no auto-publish, so nothing changes on the published document until POST …/draft/publish. Idempotent: a draft that is already workbook-only returns 200 unchanged.

A document carries at most one of a dashboard or an app — never both; workbook-only is valid. The app HTML and settings live only at the app sub-resource routes; the document read carries an app slice pointing here, and the whole-document PATCH accepts that slice back only as it was read.

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

Request

  • Base URL
    https://omniapp.co (the document declares no server; this is the origin it was published from)
  • URL
    https://omniapp.co/api/v2/documents/{identifier}/draft/{draftIdentifier}/app
  • Auth
    HTTP bearer

Path parameters

draftIdentifierstring required

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

Example:def456
identifierstring required

Published document identifier.

Example:abc123

Response

App removed on the draft (or a no-op when already workbook-only).

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.

Changes