Create draft and patch document

curl --request PATCH \
  --url https://{instance}.omniapp.co/api/v2/documents/{documentId}/draft \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Q2 Revenue (final)",
  "summary": "Rename and enable cross-filtering",
  "settings": {
    "crossfilterEnabled": true
  }
}
'

{
  "identifier": "q2-revenue",
  "draftIdentifier": "q2-revenue-draft-7f3a",
  "name": "Q2 Revenue (final)",
  "description": "Quarterly revenue review"
}

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

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

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

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

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

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

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

PATCH

documents

{documentId}

draft

curl --request PATCH \
  --url https://{instance}.omniapp.co/api/v2/documents/{documentId}/draft \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Q2 Revenue (final)",
  "summary": "Rename and enable cross-filtering",
  "settings": {
    "crossfilterEnabled": true
  }
}
'

{
  "identifier": "q2-revenue",
  "draftIdentifier": "q2-revenue-draft-7f3a",
  "name": "Q2 Revenue (final)",
  "description": "Quarterly revenue review"
}

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

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

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

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

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

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

{
  "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

The published document's URL slug (e.g. abc123) or its canonical workbook UUID.

Body

application/json

The draft-route patch body plus an optional branchId selecting the branch the new draft is attached to.

branchId

string<uuid>

Branch the draft is created on. Omit for a draft on the main (unpublished) workspace.

modelId

string<uuid>

Immutable model identifier. Must match the document's current base model or the API will return a 400 error.

workbookModelId

string<uuid>

Immutable model identifier. Must match the document's current workbook model or the API will return a 400 error.

name

string

Document name.

Required string length: 1 - 254

description

string | null

Document description.

summary

string

Caller-supplied description of what this patch changes, written to the history audit trail. When omitted, Omni auto-generates one from the updated sections.

Required string length: 1 - 255

queryPresentations

object

Query presentations (tabs/tiles) keyed by record key.

Show child attributes

controls

object

Dashboard filters/controls keyed by control ID.

Show child attributes

settings

object

Document settings. Shallow-merged with the existing settings.

Show child attributes

containers

object[]

Container layout. When present, fully replaces the existing layout.

Response

Draft created and patch applied successfully.

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"

⌘I

Getting started

AI APIs

API token 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 draft and patch document

Authorizations

Path Parameters

Body

Response