OMomniapp
Documents

Upgrade dashboard layout

Upgrades a document to the advanced dashboard layout (the "File > Upgrade layout" UI action). No-ops when the document already has advanced layout. For published documents the upgrade goes through a draft/publish workflow automatically; if a draft already exists, the request returns 409 unless clearExistingDraft is set to true.

post/api/v1/documents/{identifier}/upgrade

Request

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

Path parameters

identifierstring required

Document identifier (either document ID or identifier slug)

Example:abc123

Request body

clearExistingDraftboolean

When upgrading a published document, discard any existing draft instead of failing with a conflict.

Response

Layout upgraded, or no-op if the document already had advanced layout

identifierstring required

Document identifier

upgradedboolean required

True when the layout was upgraded, false when the document already had advanced layout (no-op).

Changes

No recorded changes to this operation across all 97 revisions of this API.