Document apiReferenceLists

lists.attach

Convert non-list paragraphs to list items under an existing list sequence.

mutates documenttracked modedry runconditional
doc.lists.attach(…)

Expected result

Returns a ListsMutateItemResult confirming attachment. Tracked-mode results include `trackedChangeRefs` pointing at the pPrChange-backed numPr revision.

Inputs

targetBlockAddressOrRangerequired
kind
kind"block"required
nodeType"paragraph"required
nodeIdstringrequired
from
fromBlockAddressrequired
Fields
kind"block"required
nodeType"paragraph"required
nodeIdstringrequired
toBlockAddressrequired
Fields
kind"block"required
nodeType"paragraph"required
nodeIdstringrequired
attachToListItemAddressrequired
Fields
kind"block"required
nodeType"listItem"required
nodeIdstringrequired
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
1 additional input field
levelinteger

Result

Output fields
true
successtruerequired
itemListItemAddressrequired
Fields
kind"block"required
nodeType"listItem"required
nodeIdstringrequired
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
affectedStoriesStoryLocator[]
remappedRefsAffectedRefRemapping[]
textRangeShiftsTextRangeShift[]
txIdstring
changedboolean
trackedChangeRefsTrackedChangeAddress[]
false
successfalserequired
failureobjectrequired
Fields
code"INVALID_TARGET" | "NO_OP" | "PRECONDITION_FAILED"required
messagestringrequired
detailsunknown

Failures

Pre-apply throws

  • TARGET_NOT_FOUND
  • CAPABILITY_UNAVAILABLE
  • INVALID_TARGET

Non-applied receipt codes

  • INVALID_TARGET
  • NO_OP
  • PRECONDITION_FAILED

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