Document apiReferenceFootnotes

footnotes.update

Update the content of an existing footnote or endnote. Structured `body` content is currently available on v2-backed sessions only; v1-backed sessions return `CAPABILITY_UNAVAILABLE` for those shapes.

mutates documenttracked modedry runidempotent
doc.footnotes.update(…)

Expected result

Returns a FootnoteMutationResult indicating success with the updated footnote address or a failure.

Inputs

targetobjectrequired
Fields
kind"entity"required
entityType"footnote"required
noteIdstringrequired
patchobject | object | objectrequired
content
contentstringrequired
body
bodyobject | object[]required

Structured SDM/1 note body patch.

Variant 1

No fields.

Variant 2

No fields.

Variant 3

No fields.

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
  • INVALID_INPUT
1 more codes
  • CAPABILITY_UNAVAILABLE

Non-applied receipt codes

  • INVALID_FRAGMENT
  • 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