Document apiReferenceWatermarks

watermarks.apply

Atomically insert, replace, or remove selected watermarks in explicit scopes while preserving surrounding headers.

mutates documentdry runconditional
doc.watermarks.apply(…)

Expected result

Returns the resulting watermarks, changed header slots, preserved boundaries, and evaluated revision.

Inputs

insert
targetdocument | headerFooterSlotsrequired
document
kind"document"required
headerFooterSlots
kind"headerFooterSlots"required
slotsobject[]required
action"insert"required
watermarktext | picturerequired
text
kind"text"required
textstringrequired
fontFamilystring
fontSizePt"auto" | number
Variant 1

No fields.

Variant 2

No fields.

boldboolean
italicboolean
colorstring
opacitynumber
orientation"horizontal" | "diagonal"
placementobject
Fields
widthPtnumber
heightPtnumber
rotationDegreesnumber
behindTextboolean
horizontalobject
verticalobject
picture
kind"picture"required
srcstringrequired
scalePercent"auto" | 50 | 100 | 150 | 200 | 500
widthPtnumber
heightPtnumber
lockAspectRatioboolean
washoutboolean
opacitynumber
placementobject
Fields
widthPtnumber
heightPtnumber
rotationDegreesnumber
behindTextboolean
horizontalobject
verticalobject
replace
targetdocument | headerFooterSlotsrequired
document
kind"document"required
headerFooterSlots
kind"headerFooterSlots"required
slotsobject[]required
action"replace"required
watermarkIdsstring[]required
watermarktext | picture | picturerequired
text
kind"text"required
textstringrequired
fontFamilystring
fontSizePt"auto" | number
Variant 1

No fields.

Variant 2

No fields.

boldboolean
italicboolean
colorstring
opacitynumber
orientation"horizontal" | "diagonal"
placementobject
Fields
widthPtnumber
heightPtnumber
rotationDegreesnumber
behindTextboolean
horizontalobject
verticalobject
picture
kind"picture"required
srcstringrequired
scalePercent"auto" | 50 | 100 | 150 | 200 | 500
widthPtnumber
heightPtnumber
lockAspectRatioboolean
washoutboolean
opacitynumber
placementobject
Fields
widthPtnumber
heightPtnumber
rotationDegreesnumber
behindTextboolean
horizontalobject
verticalobject
picture
kind"picture"required
srcunknown
scalePercent"auto" | 50 | 100 | 150 | 200 | 500
widthPtnumber
heightPtnumber
lockAspectRatioboolean
washoutboolean
opacitynumber
placementobject
Fields
widthPtnumber
heightPtnumber
rotationDegreesnumber
behindTextboolean
horizontalobject
verticalobject
sourceobjectrequired
Fields
kind"existing"required
watermarkIdstringrequired
remove
targetdocument | headerFooterSlotsrequired
document
kind"document"required
headerFooterSlots
kind"headerFooterSlots"required
slotsobject[]required
action"remove"required
watermarkIdsstring[]required

Result

Output fields
true
successtruerequired
watermarksobject[]required
affectedSlotsobject[]required
preservedSlotsobject[]required
evaluatedRevisionstringrequired
dryRuntrue
false
successfalserequired
failureobjectrequired
Fields
code"TARGET_NOT_FOUND" | "INVALID_TARGET" | "INVALID_INPUT" | "PRECONDITION_FAILED" | "CAPABILITY_UNAVAILABLE" | "REVISION_MISMATCH" | "PERMISSION_DENIED" | "INTERNAL_ERROR"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
  • INVALID_TARGET
  • INVALID_INPUT
5 more codes
  • PRECONDITION_FAILED
  • CAPABILITY_UNAVAILABLE
  • REVISION_MISMATCH
  • PERMISSION_DENIED
  • INTERNAL_ERROR

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