Skip to main content
Alpha: Document API is currently alpha and subject to breaking changes.

Summary

Apply document-level default style changes to the stylesheet (word/styles.xml). Targets docDefaults run and paragraph channels with set-style patch semantics.
  • Operation ID: styles.apply
  • API member path: editor.doc.styles.apply(...)
  • Mutates document: yes
  • Idempotency: idempotent
  • Supports tracked mode: no
  • Supports dry run: yes
  • Deterministic target resolution: yes

Expected result

Returns a StylesApplyReceipt with per-channel success/failure details for each property change.

Input fields

Variant 1 (target.channel=“run”)

Variant 2 (target.channel=“paragraph”)

Example request

Output fields

Variant 1 (success=true)

Variant 2 (success=false)

Example response

Pre-apply throws

  • INVALID_TARGET
  • INVALID_INPUT
  • CAPABILITY_UNAVAILABLE
  • REVISION_MISMATCH

Non-applied failure codes

  • None

Raw schemas