Document apiReferenceFormat

format.apply

Apply inline run-property patch changes to the target range with explicit set/clear semantics.

mutates documenttracked modedry runconditional
doc.format.apply(…)

Expected result

Returns a TextMutationReceipt confirming inline styles were applied to the target range.

Inputs

target
targetSelectionTargetrequired

Selection target: {kind:'selection', start:{kind:'text', blockId, offset}, end:{kind:'text', blockId, offset}}. Use 'ref' instead when you have a search result handle.

Fields
kind"selection"required
startSelectionPointrequired

A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.

text
kind"text"required
blockIdstringrequired
offsetintegerrequired
storyStoryLocator

Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.

body
kind"story"required
storyType"body"required
headerFooterSlot
kind"story"required
storyType"headerFooterSlot"required
sectionSectionAddressrequired
headerFooterKind"header" | "footer"required
variant"default" | "first" | "even"required
resolution"effective" | "explicit"
onWrite"materializeIfInherited" | "editResolvedPart" | "error"
headerFooterPart
kind"story"required
storyType"headerFooterPart"required
refIdstringrequired
footnote
kind"story"required
storyType"footnote"required
noteIdstringrequired
endnote
kind"story"required
storyType"endnote"required
noteIdstringrequired
textbox
kind"story"required
storyType"textbox"required
textboxIdstringrequired
nodeEdge
kind"nodeEdge"required
nodeSelectionEdgeNodeAddressrequired
edge"before" | "after"required
endSelectionPointrequired

A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.

text
kind"text"required
blockIdstringrequired
offsetintegerrequired
storyStoryLocator

Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.

body
kind"story"required
storyType"body"required
headerFooterSlot
kind"story"required
storyType"headerFooterSlot"required
sectionSectionAddressrequired
headerFooterKind"header" | "footer"required
variant"default" | "first" | "even"required
resolution"effective" | "explicit"
onWrite"materializeIfInherited" | "editResolvedPart" | "error"
headerFooterPart
kind"story"required
storyType"headerFooterPart"required
refIdstringrequired
footnote
kind"story"required
storyType"footnote"required
noteIdstringrequired
endnote
kind"story"required
storyType"endnote"required
noteIdstringrequired
textbox
kind"story"required
storyType"textbox"required
textboxIdstringrequired
nodeEdge
kind"nodeEdge"required
nodeSelectionEdgeNodeAddressrequired
edge"before" | "after"required
storyStoryLocator

Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.

body
kind"story"required
storyType"body"required
headerFooterSlot
kind"story"required
storyType"headerFooterSlot"required
sectionSectionAddressrequired
headerFooterKind"header" | "footer"required
variant"default" | "first" | "even"required
resolution"effective" | "explicit"
onWrite"materializeIfInherited" | "editResolvedPart" | "error"
headerFooterPart
kind"story"required
storyType"headerFooterPart"required
refIdstringrequired
footnote
kind"story"required
storyType"footnote"required
noteIdstringrequired
endnote
kind"story"required
storyType"endnote"required
noteIdstringrequired
textbox
kind"story"required
storyType"textbox"required
textboxIdstringrequired
coordinateSpaceTextCoordinateSpace
inStoryLocator

Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.

body
kind"story"required
storyType"body"required
headerFooterSlot
kind"story"required
storyType"headerFooterSlot"required
sectionSectionAddressrequired
Fields
kind"section"required
sectionIdstringrequired
headerFooterKind"header" | "footer"required
variant"default" | "first" | "even"required
resolution"effective" | "explicit"
onWrite"materializeIfInherited" | "editResolvedPart" | "error"
headerFooterPart
kind"story"required
storyType"headerFooterPart"required
refIdstringrequired
footnote
kind"story"required
storyType"footnote"required
noteIdstringrequired
endnote
kind"story"required
storyType"endnote"required
noteIdstringrequired
textbox
kind"story"required
storyType"textbox"required
textboxIdstringrequired
inlineobjectrequired

Inline formatting properties to apply. Set a property to apply it, use null to clear it. Example: {bold: true, italic: true} or {bold: null} to remove bold.

Fields
boldboolean | null
Variant 1

No fields.

Variant 2

No fields.

italicboolean | null
Variant 1

No fields.

Variant 2

No fields.

strikeboolean | null
Variant 1

No fields.

Variant 2

No fields.

underlineboolean | null | object
Variant 1

No fields.

Variant 2

No fields.

Variant 3
stylestring | null
Variant 1

No fields.

Variant 2

No fields.

colorstring | null
Variant 1

No fields.

Variant 2

No fields.

themeColorstring | null
Variant 1

No fields.

Variant 2

No fields.

highlightstring | null
Variant 1

No fields.

Variant 2

No fields.

colorstring | null
Variant 1

No fields.

Variant 2

No fields.

fontSizenumber | null
Variant 1

No fields.

Variant 2

No fields.

fontFamilystring | null
Variant 1

No fields.

Variant 2

No fields.

letterSpacingnumber | null
Variant 1

No fields.

Variant 2

No fields.

vertAlign"superscript" | "subscript" | "baseline" | null
Variant 1

No fields.

Variant 2

No fields.

positionnumber | null
Variant 1

No fields.

Variant 2

No fields.

dstrikeboolean | null
Variant 1

No fields.

Variant 2

No fields.

smallCapsboolean | null
Variant 1

No fields.

Variant 2

No fields.

capsboolean | null
Variant 1

No fields.

Variant 2

No fields.

shadingobject | null
Variant 1
fillstring | null
Variant 1

No fields.

Variant 2

No fields.

colorstring | null
Variant 1

No fields.

Variant 2

No fields.

valstring | null
Variant 1

No fields.

Variant 2

No fields.

Variant 2

No fields.

borderobject | null
Variant 1
valstring | null
Variant 1

No fields.

Variant 2

No fields.

sznumber | null
Variant 1

No fields.

Variant 2

No fields.

colorstring | null
Variant 1

No fields.

Variant 2

No fields.

spacenumber | null
Variant 1

No fields.

Variant 2

No fields.

Variant 2

No fields.

outlineboolean | null
Variant 1

No fields.

Variant 2

No fields.

shadowboolean | null
Variant 1

No fields.

Variant 2

No fields.

embossboolean | null
Variant 1

No fields.

Variant 2

No fields.

imprintboolean | null
Variant 1

No fields.

Variant 2

No fields.

charScalenumber | null
Variant 1

No fields.

Variant 2

No fields.

kerningnumber | null
Variant 1

No fields.

Variant 2

No fields.

vanishboolean | null
Variant 1

No fields.

Variant 2

No fields.

webHiddenboolean | null
Variant 1

No fields.

Variant 2

No fields.

specVanishboolean | null
Variant 1

No fields.

Variant 2

No fields.

rtlboolean | null
Variant 1

No fields.

Variant 2

No fields.

csboolean | null
Variant 1

No fields.

Variant 2

No fields.

bCsboolean | null
Variant 1

No fields.

Variant 2

No fields.

iCsboolean | null
Variant 1

No fields.

Variant 2

No fields.

eastAsianLayoutobject | null
Variant 1
idstring | null
Variant 1

No fields.

Variant 2

No fields.

combineboolean | null
Variant 1

No fields.

Variant 2

No fields.

combineBracketsstring | null
Variant 1

No fields.

Variant 2

No fields.

vertboolean | null
Variant 1

No fields.

Variant 2

No fields.

vertCompressboolean | null
Variant 1

No fields.

Variant 2

No fields.

Variant 2

No fields.

emstring | null
Variant 1

No fields.

Variant 2

No fields.

fitTextobject | null
Variant 1
valnumber | null
Variant 1

No fields.

Variant 2

No fields.

idstring | null
Variant 1

No fields.

Variant 2

No fields.

Variant 2

No fields.

snapToGridboolean | null
Variant 1

No fields.

Variant 2

No fields.

langobject | null
Variant 1
valstring | null
Variant 1

No fields.

Variant 2

No fields.

eastAsiastring | null
Variant 1

No fields.

Variant 2

No fields.

bidistring | null
Variant 1

No fields.

Variant 2

No fields.

Variant 2

No fields.

oMathboolean | null
Variant 1

No fields.

Variant 2

No fields.

rStylestring | null
Variant 1

No fields.

Variant 2

No fields.

rFontsobject | null
Variant 1
asciistring | null
Variant 1

No fields.

Variant 2

No fields.

hAnsistring | null
Variant 1

No fields.

Variant 2

No fields.

eastAsiastring | null
Variant 1

No fields.

Variant 2

No fields.

csstring | null
Variant 1

No fields.

Variant 2

No fields.

asciiThemestring | null
Variant 1

No fields.

Variant 2

No fields.

hAnsiThemestring | null
Variant 1

No fields.

Variant 2

No fields.

eastAsiaThemestring | null
Variant 1

No fields.

Variant 2

No fields.

csThemestring | null
Variant 1

No fields.

Variant 2

No fields.

hintstring | null
Variant 1

No fields.

Variant 2

No fields.

Variant 2

No fields.

fontSizeCsnumber | null
Variant 1

No fields.

Variant 2

No fields.

ligaturesstring | null
Variant 1

No fields.

Variant 2

No fields.

numFormstring | null
Variant 1

No fields.

Variant 2

No fields.

numSpacingstring | null
Variant 1

No fields.

Variant 2

No fields.

stylisticSetsobject[] | null
Variant 1

No fields.

Variant 2

No fields.

contextualAlternatesboolean | null
Variant 1

No fields.

Variant 2

No fields.

ref
refstringrequired

Handle ref string from a superdoc_search result. Pass the handle.ref value directly (e.g. 'text:eyJ...'). Preferred over 'target' for inline formatting.

inStoryLocator

Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.

body
kind"story"required
storyType"body"required
headerFooterSlot
kind"story"required
storyType"headerFooterSlot"required
sectionSectionAddressrequired
Fields
kind"section"required
sectionIdstringrequired
headerFooterKind"header" | "footer"required
variant"default" | "first" | "even"required
resolution"effective" | "explicit"
onWrite"materializeIfInherited" | "editResolvedPart" | "error"
headerFooterPart
kind"story"required
storyType"headerFooterPart"required
refIdstringrequired
footnote
kind"story"required
storyType"footnote"required
noteIdstringrequired
endnote
kind"story"required
storyType"endnote"required
noteIdstringrequired
textbox
kind"story"required
storyType"textbox"required
textboxIdstringrequired
inlineobjectrequired

Inline formatting properties to apply. Set a property to apply it, use null to clear it. Example: {bold: true, italic: true} or {bold: null} to remove bold.

Fields
boldboolean | null
Variant 1

No fields.

Variant 2

No fields.

italicboolean | null
Variant 1

No fields.

Variant 2

No fields.

strikeboolean | null
Variant 1

No fields.

Variant 2

No fields.

underlineboolean | null | object
Variant 1

No fields.

Variant 2

No fields.

Variant 3
stylestring | null
Variant 1

No fields.

Variant 2

No fields.

colorstring | null
Variant 1

No fields.

Variant 2

No fields.

themeColorstring | null
Variant 1

No fields.

Variant 2

No fields.

highlightstring | null
Variant 1

No fields.

Variant 2

No fields.

colorstring | null
Variant 1

No fields.

Variant 2

No fields.

fontSizenumber | null
Variant 1

No fields.

Variant 2

No fields.

fontFamilystring | null
Variant 1

No fields.

Variant 2

No fields.

letterSpacingnumber | null
Variant 1

No fields.

Variant 2

No fields.

vertAlign"superscript" | "subscript" | "baseline" | null
Variant 1

No fields.

Variant 2

No fields.

positionnumber | null
Variant 1

No fields.

Variant 2

No fields.

dstrikeboolean | null
Variant 1

No fields.

Variant 2

No fields.

smallCapsboolean | null
Variant 1

No fields.

Variant 2

No fields.

capsboolean | null
Variant 1

No fields.

Variant 2

No fields.

shadingobject | null
Variant 1
fillstring | null
Variant 1

No fields.

Variant 2

No fields.

colorstring | null
Variant 1

No fields.

Variant 2

No fields.

valstring | null
Variant 1

No fields.

Variant 2

No fields.

Variant 2

No fields.

borderobject | null
Variant 1
valstring | null
Variant 1

No fields.

Variant 2

No fields.

sznumber | null
Variant 1

No fields.

Variant 2

No fields.

colorstring | null
Variant 1

No fields.

Variant 2

No fields.

spacenumber | null
Variant 1

No fields.

Variant 2

No fields.

Variant 2

No fields.

outlineboolean | null
Variant 1

No fields.

Variant 2

No fields.

shadowboolean | null
Variant 1

No fields.

Variant 2

No fields.

embossboolean | null
Variant 1

No fields.

Variant 2

No fields.

imprintboolean | null
Variant 1

No fields.

Variant 2

No fields.

charScalenumber | null
Variant 1

No fields.

Variant 2

No fields.

kerningnumber | null
Variant 1

No fields.

Variant 2

No fields.

vanishboolean | null
Variant 1

No fields.

Variant 2

No fields.

webHiddenboolean | null
Variant 1

No fields.

Variant 2

No fields.

specVanishboolean | null
Variant 1

No fields.

Variant 2

No fields.

rtlboolean | null
Variant 1

No fields.

Variant 2

No fields.

csboolean | null
Variant 1

No fields.

Variant 2

No fields.

bCsboolean | null
Variant 1

No fields.

Variant 2

No fields.

iCsboolean | null
Variant 1

No fields.

Variant 2

No fields.

eastAsianLayoutobject | null
Variant 1
idstring | null
Variant 1

No fields.

Variant 2

No fields.

combineboolean | null
Variant 1

No fields.

Variant 2

No fields.

combineBracketsstring | null
Variant 1

No fields.

Variant 2

No fields.

vertboolean | null
Variant 1

No fields.

Variant 2

No fields.

vertCompressboolean | null
Variant 1

No fields.

Variant 2

No fields.

Variant 2

No fields.

emstring | null
Variant 1

No fields.

Variant 2

No fields.

fitTextobject | null
Variant 1
valnumber | null
Variant 1

No fields.

Variant 2

No fields.

idstring | null
Variant 1

No fields.

Variant 2

No fields.

Variant 2

No fields.

snapToGridboolean | null
Variant 1

No fields.

Variant 2

No fields.

langobject | null
Variant 1
valstring | null
Variant 1

No fields.

Variant 2

No fields.

eastAsiastring | null
Variant 1

No fields.

Variant 2

No fields.

bidistring | null
Variant 1

No fields.

Variant 2

No fields.

Variant 2

No fields.

oMathboolean | null
Variant 1

No fields.

Variant 2

No fields.

rStylestring | null
Variant 1

No fields.

Variant 2

No fields.

rFontsobject | null
Variant 1
asciistring | null
Variant 1

No fields.

Variant 2

No fields.

hAnsistring | null
Variant 1

No fields.

Variant 2

No fields.

eastAsiastring | null
Variant 1

No fields.

Variant 2

No fields.

csstring | null
Variant 1

No fields.

Variant 2

No fields.

asciiThemestring | null
Variant 1

No fields.

Variant 2

No fields.

hAnsiThemestring | null
Variant 1

No fields.

Variant 2

No fields.

eastAsiaThemestring | null
Variant 1

No fields.

Variant 2

No fields.

csThemestring | null
Variant 1

No fields.

Variant 2

No fields.

hintstring | null
Variant 1

No fields.

Variant 2

No fields.

Variant 2

No fields.

fontSizeCsnumber | null
Variant 1

No fields.

Variant 2

No fields.

ligaturesstring | null
Variant 1

No fields.

Variant 2

No fields.

numFormstring | null
Variant 1

No fields.

Variant 2

No fields.

numSpacingstring | null
Variant 1

No fields.

Variant 2

No fields.

stylisticSetsobject[] | null
Variant 1

No fields.

Variant 2

No fields.

contextualAlternatesboolean | null
Variant 1

No fields.

Variant 2

No fields.

Result

Output fields
true
successtruerequired
resolutionTextMutationResolutionrequired
Fields
requestedTargetTextAddress
Fields
kind"text"required
blockIdstringrequired
rangeRangerequired
storyStoryLocator

Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.

body
kind"story"required
storyType"body"required
headerFooterSlot
kind"story"required
storyType"headerFooterSlot"required
sectionSectionAddressrequired
headerFooterKind"header" | "footer"required
variant"default" | "first" | "even"required
resolution"effective" | "explicit"
onWrite"materializeIfInherited" | "editResolvedPart" | "error"
headerFooterPart
kind"story"required
storyType"headerFooterPart"required
refIdstringrequired
footnote
kind"story"required
storyType"footnote"required
noteIdstringrequired
endnote
kind"story"required
storyType"endnote"required
noteIdstringrequired
textbox
kind"story"required
storyType"textbox"required
textboxIdstringrequired
targetTextAddressrequired
Fields
kind"text"required
blockIdstringrequired
rangeRangerequired
storyStoryLocator

Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.

body
kind"story"required
storyType"body"required
headerFooterSlot
kind"story"required
storyType"headerFooterSlot"required
sectionSectionAddressrequired
headerFooterKind"header" | "footer"required
variant"default" | "first" | "even"required
resolution"effective" | "explicit"
onWrite"materializeIfInherited" | "editResolvedPart" | "error"
headerFooterPart
kind"story"required
storyType"headerFooterPart"required
refIdstringrequired
footnote
kind"story"required
storyType"footnote"required
noteIdstringrequired
endnote
kind"story"required
storyType"endnote"required
noteIdstringrequired
textbox
kind"story"required
storyType"textbox"required
textboxIdstringrequired
rangeTextMutationRangerequired
Fields
fromintegerrequired
tointegerrequired
textstringrequired
selectionTargetSelectionTarget
Fields
kind"selection"required
startSelectionPointrequired

A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.

text
kind"text"required
blockIdstringrequired
offsetintegerrequired
storyStoryLocator

Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.

body
kind"story"required
storyType"body"required
headerFooterSlot
kind"story"required
storyType"headerFooterSlot"required
sectionSectionAddressrequired
headerFooterKind"header" | "footer"required
variant"default" | "first" | "even"required
resolution"effective" | "explicit"
onWrite"materializeIfInherited" | "editResolvedPart" | "error"
headerFooterPart
kind"story"required
storyType"headerFooterPart"required
refIdstringrequired
footnote
kind"story"required
storyType"footnote"required
noteIdstringrequired
endnote
kind"story"required
storyType"endnote"required
noteIdstringrequired
textbox
kind"story"required
storyType"textbox"required
textboxIdstringrequired
nodeEdge
kind"nodeEdge"required
nodeSelectionEdgeNodeAddressrequired
edge"before" | "after"required
endSelectionPointrequired

A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.

text
kind"text"required
blockIdstringrequired
offsetintegerrequired
storyStoryLocator

Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.

body
kind"story"required
storyType"body"required
headerFooterSlot
kind"story"required
storyType"headerFooterSlot"required
sectionSectionAddressrequired
headerFooterKind"header" | "footer"required
variant"default" | "first" | "even"required
resolution"effective" | "explicit"
onWrite"materializeIfInherited" | "editResolvedPart" | "error"
headerFooterPart
kind"story"required
storyType"headerFooterPart"required
refIdstringrequired
footnote
kind"story"required
storyType"footnote"required
noteIdstringrequired
endnote
kind"story"required
storyType"endnote"required
noteIdstringrequired
textbox
kind"story"required
storyType"textbox"required
textboxIdstringrequired
nodeEdge
kind"nodeEdge"required
nodeSelectionEdgeNodeAddressrequired
edge"before" | "after"required
storyStoryLocator

Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.

body
kind"story"required
storyType"body"required
headerFooterSlot
kind"story"required
storyType"headerFooterSlot"required
sectionSectionAddressrequired
headerFooterKind"header" | "footer"required
variant"default" | "first" | "even"required
resolution"effective" | "explicit"
onWrite"materializeIfInherited" | "editResolvedPart" | "error"
headerFooterPart
kind"story"required
storyType"headerFooterPart"required
refIdstringrequired
footnote
kind"story"required
storyType"footnote"required
noteIdstringrequired
endnote
kind"story"required
storyType"endnote"required
noteIdstringrequired
textbox
kind"story"required
storyType"textbox"required
textboxIdstringrequired
coordinateSpaceTextCoordinateSpace
insertedEntityAddress[]
updatedEntityAddress[]
removedEntityAddress[]
effectsReceiptEffects
Fields
insertedTextTextMutationEffect[]
insertedBlocksBlockMutationEffect[]
false
successfalserequired
failureobjectrequired
Fields
code"INVALID_TARGET" | "NO_OP"required
messagestringrequired
detailsunknown
resolutionTextMutationResolutionrequired
Fields
requestedTargetTextAddress
Fields
kind"text"required
blockIdstringrequired
rangeRangerequired
storyStoryLocator

Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.

body
kind"story"required
storyType"body"required
headerFooterSlot
kind"story"required
storyType"headerFooterSlot"required
sectionSectionAddressrequired
headerFooterKind"header" | "footer"required
variant"default" | "first" | "even"required
resolution"effective" | "explicit"
onWrite"materializeIfInherited" | "editResolvedPart" | "error"
headerFooterPart
kind"story"required
storyType"headerFooterPart"required
refIdstringrequired
footnote
kind"story"required
storyType"footnote"required
noteIdstringrequired
endnote
kind"story"required
storyType"endnote"required
noteIdstringrequired
textbox
kind"story"required
storyType"textbox"required
textboxIdstringrequired
targetTextAddressrequired
Fields
kind"text"required
blockIdstringrequired
rangeRangerequired
storyStoryLocator

Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.

body
kind"story"required
storyType"body"required
headerFooterSlot
kind"story"required
storyType"headerFooterSlot"required
sectionSectionAddressrequired
headerFooterKind"header" | "footer"required
variant"default" | "first" | "even"required
resolution"effective" | "explicit"
onWrite"materializeIfInherited" | "editResolvedPart" | "error"
headerFooterPart
kind"story"required
storyType"headerFooterPart"required
refIdstringrequired
footnote
kind"story"required
storyType"footnote"required
noteIdstringrequired
endnote
kind"story"required
storyType"endnote"required
noteIdstringrequired
textbox
kind"story"required
storyType"textbox"required
textboxIdstringrequired
rangeTextMutationRangerequired
Fields
fromintegerrequired
tointegerrequired
textstringrequired
selectionTargetSelectionTarget
Fields
kind"selection"required
startSelectionPointrequired

A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.

text
kind"text"required
blockIdstringrequired
offsetintegerrequired
storyStoryLocator

Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.

body
kind"story"required
storyType"body"required
headerFooterSlot
kind"story"required
storyType"headerFooterSlot"required
sectionSectionAddressrequired
headerFooterKind"header" | "footer"required
variant"default" | "first" | "even"required
resolution"effective" | "explicit"
onWrite"materializeIfInherited" | "editResolvedPart" | "error"
headerFooterPart
kind"story"required
storyType"headerFooterPart"required
refIdstringrequired
footnote
kind"story"required
storyType"footnote"required
noteIdstringrequired
endnote
kind"story"required
storyType"endnote"required
noteIdstringrequired
textbox
kind"story"required
storyType"textbox"required
textboxIdstringrequired
nodeEdge
kind"nodeEdge"required
nodeSelectionEdgeNodeAddressrequired
edge"before" | "after"required
endSelectionPointrequired

A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.

text
kind"text"required
blockIdstringrequired
offsetintegerrequired
storyStoryLocator

Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.

body
kind"story"required
storyType"body"required
headerFooterSlot
kind"story"required
storyType"headerFooterSlot"required
sectionSectionAddressrequired
headerFooterKind"header" | "footer"required
variant"default" | "first" | "even"required
resolution"effective" | "explicit"
onWrite"materializeIfInherited" | "editResolvedPart" | "error"
headerFooterPart
kind"story"required
storyType"headerFooterPart"required
refIdstringrequired
footnote
kind"story"required
storyType"footnote"required
noteIdstringrequired
endnote
kind"story"required
storyType"endnote"required
noteIdstringrequired
textbox
kind"story"required
storyType"textbox"required
textboxIdstringrequired
nodeEdge
kind"nodeEdge"required
nodeSelectionEdgeNodeAddressrequired
edge"before" | "after"required
storyStoryLocator

Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.

body
kind"story"required
storyType"body"required
headerFooterSlot
kind"story"required
storyType"headerFooterSlot"required
sectionSectionAddressrequired
headerFooterKind"header" | "footer"required
variant"default" | "first" | "even"required
resolution"effective" | "explicit"
onWrite"materializeIfInherited" | "editResolvedPart" | "error"
headerFooterPart
kind"story"required
storyType"headerFooterPart"required
refIdstringrequired
footnote
kind"story"required
storyType"footnote"required
noteIdstringrequired
endnote
kind"story"required
storyType"endnote"required
noteIdstringrequired
textbox
kind"story"required
storyType"textbox"required
textboxIdstringrequired
coordinateSpaceTextCoordinateSpace

Failures

Pre-apply throws

  • TARGET_NOT_FOUND
  • CAPABILITY_UNAVAILABLE
  • INVALID_TARGET
6 more codes
  • INVALID_INPUT
  • STORY_NOT_FOUND
  • STORY_MISMATCH
  • STORY_NOT_SUPPORTED
  • CROSS_STORY_PLAN
  • MATERIALIZATION_FAILED

Non-applied receipt codes

  • INVALID_TARGET
  • NO_OP

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