Patch draft
Apply a patch to an existing draft. Pure apply — no draft creation, no publish. The request body, content sections, field caps, and tile-addressing rules are identical to Create draft and patch document; this route does not accept branchId.
Authorizations
Can be either an Organization API Key or Personal Access Token (PAT).
Include in the Authorization header as: Bearer YOUR_TOKEN
Path Parameters
The published document's URL slug (e.g. abc123) or its canonical workbook UUID.
The draft workbook identifier the patch is applied to.
Body
The content/metadata diff applied to a draft. All fields optional — only the sections present are changed.
Immutable model identifier. Must match the document's current base model or the API will return a 400 error.
Immutable model identifier. Must match the document's current workbook model or the API will return a 400 error.
Document name.
1 - 254Document description.
Caller-supplied description of what this patch changes, written to the history audit trail. When omitted, Omni auto-generates one from the updated sections.
1 - 255Query presentations (tabs/tiles) keyed by record key.
Dashboard filters/controls keyed by control ID.
Document settings. Shallow-merged with the existing settings.
Container layout. When present, fully replaces the existing layout.
Response
Patch applied to draft successfully.
Published document identifier the draft targets.
"def456"
Identifier of the draft the patch was applied to.
"abc123"
Document name.
"Blob Sales"
Document description.
"Overview of daily Blobs R Us Sales"

