diff.apply
Apply a previously computed diff payload to the current document. The document fingerprint must match the diff base fingerprint. Omitted changeMode applies story content directly; explicit tracked mode governs all four story families (body, header/footer parts, footnotes, endnotes). Comments, styles, and numbering are always applied directly. Supported mixed full-diff payloads apply atomically across body, comments, styles, numbering, and header/footers. Unsupported/deferred families such as package-graph/media/hyperlink closure, settings/theme, and textboxes fail closed before mutation.
doc.diff.apply(…)Expected result
Returns a DiffApplyResult with applied operation count and diagnostics.
Inputs
diffobjectrequiredFields
version"sd-diff-payload/v1" | "sd-diff-payload/v2"requiredengine"superdoc-v2"requiredbaseFingerprintstringrequiredtargetFingerprintstringrequiredcoverageobjectrequiredFields
bodytruerequiredcommentsbooleanrequiredstylesbooleanrequirednumberingbooleanrequiredheaderFootersbooleanrequiredsummaryobjectrequiredFields
hasChangesbooleanrequiredchangedComponents"body" | "comments" | "styles" | "numbering" | "headerFooters" | "parts"[]requiredbodyobjectrequiredcommentsobjectrequiredstylesobjectrequirednumberingobjectrequiredheaderFootersobjectrequiredpartsobjectrequiredpayloadobjectrequiredOpaque engine-owned diff data.
Result
Output fields
appliedOperationsintegerrequiredbaseFingerprintstringrequiredtargetFingerprintstringrequiredcoverageobjectrequiredFields
bodytruerequiredcommentsbooleanrequiredstylesbooleanrequirednumberingbooleanrequiredheaderFootersbooleanrequiredsummaryobjectrequiredFields
hasChangesbooleanrequiredchangedComponents"body" | "comments" | "styles" | "numbering" | "headerFooters" | "parts"[]requiredbodyobjectrequiredFields
hasChangesbooleanrequiredcommentsobjectrequiredFields
hasChangesbooleanrequiredstylesobjectrequiredFields
hasChangesbooleanrequirednumberingobjectrequiredFields
hasChangesbooleanrequiredheaderFootersobjectrequiredFields
hasChangesbooleanrequiredpartsobjectrequiredFields
hasChangesbooleanrequireddiagnosticsstring[]requiredFailures
Pre-apply throws
INVALID_INPUTCAPABILITY_UNSUPPORTEDPRECONDITION_FAILED
1 more codes
CAPABILITY_UNAVAILABLE
Raw schemas
Open the generated JSON artifact for the exact input, output, success, and failure schemas represented by this contract version.
View raw JSON schemas