Document apiReferenceWatermarks

watermarks.insert

Insert a Word-compatible text or picture watermark into a header scope. Available on v2-backed sessions only; v1-backed sessions currently return `CAPABILITY_UNAVAILABLE`.

mutates documentdry runnon-idempotent
doc.watermarks.insert(…)

Expected result

Returns the inserted watermark, including its stable identity and effective header scopes.

Inputs

targetdocument | headerFooterSlotrequired
document
kind"document"required
headerFooterSlot
kind"headerFooterSlot"required
sectionSectionAddressrequired
Fields
kind"section"required
sectionIdstringrequired
headerFooterKind"header"required
variant"default" | "first" | "even"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

Result

Output fields
true
successtruerequired
watermarkobjectrequired
Fields
watermarkIdstringrequired
ownerobjectrequired
Fields
refIdstringrequired
partPathstringrequired
effectiveInobject[]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
picture
kind"picture"required
mediaPartPathstringrequired
contentTypestringrequired
scalePercent"auto" | 50 | 100 | 150 | 200 | 500required
widthPtnumberrequired
heightPtnumberrequired
lockAspectRatiobooleanrequired
washoutbooleanrequired
opacitynumberrequired
placementobjectrequired
watermarksobject[]
false
successfalserequired
failureobjectrequired
Fields
code"INVALID_TARGET" | "PRECONDITION_FAILED"required
messagestringrequired
detailsunknown

Failures

Pre-apply throws

  • INVALID_INPUT
  • INVALID_TARGET
  • CAPABILITY_UNAVAILABLE
1 more codes
  • INTERNAL_ERROR

Non-applied receipt codes

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