Document apiReferenceWatermarks

watermarks.remove

Remove a watermark without removing unrelated header content. Available on v2-backed sessions only; v1-backed sessions currently return `CAPABILITY_UNAVAILABLE`.

mutates documentdry runconditional
doc.watermarks.remove(…)

Expected result

Returns the removed watermark identity, or TARGET_NOT_FOUND when its identity is stale.

Inputs

targetobjectrequired
Fields
kind"watermark"required
watermarkIdstringrequired

Result

Output fields
true
successtruerequired
watermarkIdstringrequired
false
successfalserequired
failureobjectrequired
Fields
code"TARGET_NOT_FOUND" | "PRECONDITION_FAILED"required
messagestringrequired
detailsunknown

Failures

Pre-apply throws

  • INVALID_INPUT
  • INVALID_TARGET
  • CAPABILITY_UNAVAILABLE
1 more codes
  • INTERNAL_ERROR

Non-applied receipt codes

  • TARGET_NOT_FOUND
  • PRECONDITION_FAILED

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