Document apiReferenceLists

lists.join

Merge two adjacent list sequences into one.

mutates documentdry runconditional
doc.lists.join(…)

Expected result

Returns a ListsJoinResult with the resulting listId of the merged sequence.

Inputs

targetListItemAddressrequired
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
direction"withPrevious" | "withNext"required

Result

Output fields
true
successtruerequired
listIdstringrequired
false
successfalserequired
failureobjectrequired
Fields
code"INVALID_TARGET" | "NO_ADJACENT_SEQUENCE" | "INCOMPATIBLE_DEFINITIONS" | "ALREADY_SAME_SEQUENCE"required
messagestringrequired
detailsunknown

Failures

Pre-apply throws

  • TARGET_NOT_FOUND
  • CAPABILITY_UNAVAILABLE
  • INVALID_TARGET

Non-applied receipt codes

  • INVALID_TARGET
  • NO_ADJACENT_SEQUENCE
  • INCOMPATIBLE_DEFINITIONS
1 more codes
  • ALREADY_SAME_SEQUENCE

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