Document apiReferenceImages

images.delete

Delete an image from the document.

mutates documenttracked modedry runconditional
doc.images.delete(…)

Expected result

Returns an ImagesMutationResult indicating success or failure.

Inputs

imageIdstringrequired

Result

Output fields
successboolean
appliedChangeMode"direct" | "tracked"
imageobject
failureobject

Failures

Pre-apply throws

  • TARGET_NOT_FOUND
  • AMBIGUOUS_TARGET
  • INVALID_TARGET
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