Skip to main content

Summary

Delete an image from the document.
  • Operation ID: images.delete
  • API member path: editor.doc.images.delete(...)
  • Mutates document: yes
  • Idempotency: conditional
  • Supports tracked mode: yes
  • Supports dry run: yes
  • Deterministic target resolution: yes

Expected result

Returns an ImagesMutationResult indicating success or failure.

Input fields

Example request

Output fields

Example response

Pre-apply throws

  • TARGET_NOT_FOUND
  • AMBIGUOUS_TARGET
  • INVALID_TARGET
  • CAPABILITY_UNAVAILABLE

Non-applied failure codes

  • NO_OP

Raw schemas