Upgrade dashboard layout

curl --request POST \
  --url https://{instance}.omniapp.co/api/v1/documents/{identifier}/upgrade \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "clearExistingDraft": true
}
'

{
  "identifier": "abc123",
  "upgraded": true
}

Documents

Upgrade dashboard layout

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

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

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

documents

{identifier}

upgrade

Upgrade dashboard layout

curl --request POST \
  --url https://{instance}.omniapp.co/api/v1/documents/{identifier}/upgrade \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "clearExistingDraft": true
}
'

{
  "identifier": "abc123",
  "upgraded": true
}

Authorizations

Authorization

string

header

required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

identifier

string

required

Document identifier (either document ID or identifier slug)

Body

application/json

clearExistingDraft

boolean

default:false

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.

identifier

string

required

Document identifier

upgraded

boolean

required

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

Duplicate published document

Transfer document ownership

⌘I