headerFooters.pageNumbers.remove

Atomically remove a section's PAGE fields from its header, footer, or both, keeping other header and footer content. Available on v2-backed sessions only; v1-backed sessions currently return `CAPABILITY_UNAVAILABLE`.

mutates documentdry runconditional
doc.headerFooters.pageNumbers.remove(…)

Expected result

Returns the header/footer parts that lost a PAGE field; a paragraph left with only whitespace is removed. NO_OP when the section shows no page number.

Inputs

sectionSectionAddressrequired
Fields
kind"section"required
sectionIdstringrequired
1 additional input field
kind"header" | "footer"

Result

Output fields
true
successtruerequired
sectionSectionAddressrequired
Fields
kind"section"required
sectionIdstringrequired
partsobject[]required
false
successfalserequired
failureobjectrequired
Fields
code"TARGET_NOT_FOUND" | "NO_OP" | "CAPABILITY_UNAVAILABLE" | "INTERNAL_ERROR"required
messagestringrequired
detailsunknown

Failures

Pre-apply throws

  • INVALID_INPUT
  • INVALID_TARGET
  • CAPABILITY_UNAVAILABLE
1 more codes
  • INTERNAL_ERROR

Non-applied receipt codes

  • TARGET_NOT_FOUND
  • NO_OP
  • CAPABILITY_UNAVAILABLE
1 more codes
  • INTERNAL_ERROR

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