v4

latestOpenAPI 3.1.02026-08-01207318738.7 KB

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

Path parameters

identifierstring required

Document identifier (either document ID or identifier slug)

Example:abc123

Document identifier (either document ID or identifier slug)

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