headerFooters.refs.clear

Clear an explicit header/footer reference from a section slot.

mutates documentdry runconditional
doc.headerFooters.refs.clear(…)

Expected result

Returns a SectionMutationResult receipt; reports NO_OP if no explicit reference existed.

Inputs

targetobjectrequired
Fields
kind"headerFooterSlot"required
sectionSectionAddressrequired
Fields
kind"section"required
sectionIdstringrequired
headerFooterKind"header" | "footer"required
variant"default" | "first" | "even"required

Result

Output fields
true
successtruerequired
sectionSectionAddressrequired
Fields
kind"section"required
sectionIdstringrequired
false
successfalserequired
failureobjectrequired
Fields
code"NO_OP"required
messagestringrequired
detailsunknown

Failures

Pre-apply throws

  • TARGET_NOT_FOUND
  • INVALID_TARGET
  • INVALID_INPUT
2 more codes
  • CAPABILITY_UNAVAILABLE
  • INTERNAL_ERROR

Non-applied receipt codes

  • 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