Document apiReferenceFootnotes

footnotes.remove

Remove a footnote or endnote from the document.

mutates documenttracked modedry runnon-idempotent
doc.footnotes.remove(…)

Expected result

Returns a FootnoteMutationResult indicating success or a failure.

Inputs

targetobjectrequired
Fields
kind"entity"required
entityType"footnote"required
noteIdstringrequired

Result

Output fields
true
successtruerequired
footnoteobjectrequired
Fields
kind"entity"required
entityType"footnote"required
noteIdstringrequired
false
successfalserequired
failureobjectrequired
Fields
codestringrequired
messagestringrequired
detailsunknown

Failures

Pre-apply throws

  • TARGET_NOT_FOUND
  • INVALID_TARGET
  • CAPABILITY_UNAVAILABLE

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