Create/reuse draft and replace app content

curl --request PUT \
  --url https://{instance}.omniapp.co/api/v2/documents/{documentId}/draft/app \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "html": "<!doctype html><html><body><h1>Sales overview</h1></body></html>"
}
'

{
  "identifier": "q2-revenue",
  "draftIdentifier": "q2-revenue-draft-7f3a",
  "name": "Q2 Revenue (final)",
  "description": "Quarterly revenue review",
  "app": {
    "settings": {
      "allowClipboard": false,
      "allowDefaultMapProviders": false,
      "allowDownloads": false,
      "allowExternalNavigation": false,
      "allowInternalNavigation": false,
      "externalNavOpensInNewTab": true,
      "navAllowedDomains": [],
      "navAllowedDomainsEnabled": false,
      "safeDomains": [
        "cdn.example.com"
      ],
      "safeDomainsEnabled": true
    }
  }
}

{
  "detail": "<string>",
  "status": 400
}

{
  "detail": "Unauthorized: Missing or invalid API key",
  "status": 401
}

{
  "detail": "<string>",
  "status": 403
}

{
  "detail": "<string>",
  "status": 404
}

{
  "error": "<response_code>",
  "message": "<error_reason>"
}

{
  "detail": "<string>",
  "status": 409
}

{
  "error": "<response_code>",
  "message": "<error_reason>"
}

PUT

documents

{documentId}

draft

app

curl --request PUT \
  --url https://{instance}.omniapp.co/api/v2/documents/{documentId}/draft/app \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "html": "<!doctype html><html><body><h1>Sales overview</h1></body></html>"
}
'

{
  "identifier": "q2-revenue",
  "draftIdentifier": "q2-revenue-draft-7f3a",
  "name": "Q2 Revenue (final)",
  "description": "Quarterly revenue review",
  "app": {
    "settings": {
      "allowClipboard": false,
      "allowDefaultMapProviders": false,
      "allowDownloads": false,
      "allowExternalNavigation": false,
      "allowInternalNavigation": false,
      "externalNavOpensInNewTab": true,
      "navAllowedDomains": [],
      "navAllowedDomainsEnabled": false,
      "safeDomains": [
        "cdn.example.com"
      ],
      "safeDomainsEnabled": true
    }
  }
}

{
  "detail": "<string>",
  "status": 400
}

{
  "detail": "Unauthorized: Missing or invalid API key",
  "status": 401
}

{
  "detail": "<string>",
  "status": 403
}

{
  "detail": "<string>",
  "status": 404
}

{
  "error": "<response_code>",
  "message": "<error_reason>"
}

{
  "detail": "<string>",
  "status": 409
}

{
  "error": "<response_code>",
  "message": "<error_reason>"
}

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

documentId

string

required

Document identifier — either the URL slug (e.g. abc123) or the canonical workbook UUID.

Example:

"abc123"

Body

application/json

html

string

required

The complete app HTML document. Replaces the current HTML; capped at 2 MiB of UTF-8. maxLength counts characters — the byte cap is what the server enforces. Every write appends an immutable revision.

Required string length: 1 - 2097152

settings

object

When present, replaces the app settings; omitted fields take their locked-down defaults. When absent, the current settings are retained.

Show child attributes

Response

Draft created or reused and app written. Use the draftIdentifier in the response to call the Publish draft API and publish the changes.

identifier

string

required

Published document identifier the draft targets.

Example:

"def456"

draftIdentifier

string

required

Identifier of the draft the patch was applied to.

Example:

"abc123"

name

string

required

Document name.

Example:

"Blob Sales"

description

string | null

required

Document description.

Example:

"Overview of daily Blobs R Us Sales"

app

object

required

Show child attributes

warnings

string[]

Included only when non-blocking warnings are encountered. Currently, external resource hosts the app's iframe CSP will block until an Organization Admin allows them. The write itself succeeded.

Getting started

Who am I?

AI APIs

API token APIs

App APIs

Connection APIs

Content APIs

Dashboard APIs

Document APIs

Folder APIs

Label APIs

Model APIs

Query APIs

Schedule APIs

Upload APIs

User APIs

User group APIs

Create/reuse draft and replace app content

Authorizations

Path Parameters

Body

Response