Document apiReferenceCaptions

captions.update

Append patch text to an existing caption paragraph.

mutates documentdry runnon-idempotent
doc.captions.update(…)

Expected result

Returns a CaptionMutationResult indicating success after appending patch.text to the existing caption body, or NO_OP when no text patch is provided.

Inputs

targetobjectrequired
Fields
kind"block"required
nodeType"paragraph"required
nodeIdstringrequired
patchobjectrequired
Fields
textstring

Result

Output fields
true
successtruerequired
captionobjectrequired
Fields
kind"block"required
nodeType"paragraph"required
nodeIdstringrequired
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

  • 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