v1

latestOpenAPI 3.1.02026-07-2618690613.4 KB

Documents

Upgrade dashboard layout

Upgrade a document to the advanced dashboard layout — the same action available in the UI under File > Upgrade layout.

<Note> This operation is idempotent. If the document already uses the advanced layout, the request is a no-op and returns `upgraded: false`. </Note>

For published documents the upgrade runs through a draft-and-publish workflow automatically. If a draft already exists, the request returns 409 unless clearExistingDraft is set to true, which discards the existing draft before upgrading.

post/v1/documents/{documentId}/upgrade

Path parameters

identifierstring required

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