v1

latestOpenAPI 3.1.02026-07-2618690613.4 KB

Documents v2

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.

patch/v2/documents/{documentId}/draft/{draftId}

Path parameters

documentIdstring required

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

draftIdstring required

The draft workbook identifier the patch is applied to.

Request body

modelIdstring uuid

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

workbookModelIdstring uuid

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

namestring

Document name.

descriptionstring nullable

Document description.

summarystring

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

containersobject[]

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

Response

Patch applied to draft successfully.

identifierstring required

Published document identifier the draft targets.

draftIdentifierstring required

Identifier of the draft the patch was applied to.

namestring required

Document name.

descriptionstring nullable required

Document description.

Example response

{
  "identifier": "def456",
  "draftIdentifier": "abc123",
  "name": "Blob Sales",
  "description": "Overview of daily Blobs R Us Sales"
}