Document apiReferenceStyles

styles.apply

Apply style changes to the active Style Definitions part. Targets docDefaults run and paragraph channels, or the run properties of an existing named paragraph style (scope "style"), with set-style patch semantics. Redefining a named style updates every paragraph that references it; its linked character style receives the same patch, null removes a property so the style inherits it again, and an object value replaces that property whole.

mutates documentdry runidempotent
doc.styles.apply(…)

Expected result

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

Inputs

Variant 1
targetobjectrequired
Fields
scope"docDefaults"required
channel"run"required
patchobjectrequired
Fields
boldboolean
boldCsboolean
italicboolean
iCsboolean
smallCapsboolean
strikeboolean
dstrikeboolean
embossboolean
imprintboolean
outlineboolean
shadowboolean
vanishboolean
webHiddenboolean
specVanishboolean
snapToGridboolean
noProofboolean
fontSizeinteger
fontSizeCsinteger
letterSpacinginteger
kerninteger
positioninteger
winteger
textTransform"uppercase" | "none"
vertAlign"superscript" | "subscript" | "baseline"
em"none" | "dot" | "comma" | "circle" | "sesame"
effectstring
fontFamilyobject
Fields
hintstring
asciistring
hAnsistring
eastAsiastring
csstring
valstring
asciiThemestring
hAnsiThemestring
eastAsiaThemestring
csthemestring
colorobject
Fields
valstring
themeColorstring
themeTintstring
themeShadestring
underlineobject
Fields
val"single" | "double" | "thick" | "dotted" | "dottedHeavy" | "dash" | "dashedHeavy" | "dashLong" | "dashLongHeavy" | "dotDash" | "dashDotHeavy" | "dotDotDash" | "dashDotDotHeavy" | "wave" | "wavyHeavy" | "wavyDouble" | "words" | "none"
colorstring
themeColorstring
themeTintstring
themeShadestring
bordersobject
Fields
valstring
colorstring
themeColorstring
themeTintstring
themeShadestring
sizeinteger
spaceinteger
shadowboolean
frameboolean
shadingobject
Fields
colorstring
fillstring
themeColorstring
themeFillstring
themeFillShadestring
themeFillTintstring
themeShadestring
themeTintstring
valstring
langobject
Fields
valstring
eastAsiastring
bidistring
eastAsianLayoutobject
Fields
idinteger
combineboolean
combineBracketsstring
vertboolean
vertCompressboolean
fitTextobject
Fields
valinteger
idinteger
Variant 2
targetobjectrequired
Fields
scope"docDefaults"required
channel"paragraph"required
patchobjectrequired
Fields
keepLinesboolean
keepNextboolean
widowControlboolean
contextualSpacingboolean
pageBreakBeforeboolean
suppressAutoHyphensboolean
suppressLineNumbersboolean
suppressOverlapboolean
mirrorIndentsboolean
wordWrapboolean
kinsokuboolean
overflowPunctboolean
topLinePunctboolean
autoSpaceDEboolean
autoSpaceDNboolean
adjustRightIndboolean
rightToLeftboolean
snapToGridboolean
outlineLvlinteger
justification"left" | "center" | "right" | "justify" | "distribute"
textAlignment"top" | "center" | "baseline" | "bottom" | "auto"
textDirection"lrTb" | "tbRl" | "btLr" | "lrTbV" | "tbRlV" | "tbLrV"
textboxTightWrap"none" | "allLines" | "firstAndLastLine" | "firstLineOnly" | "lastLineOnly"
spacingobject
Fields
afterinteger
afterAutospacingboolean
afterLinesinteger
beforeinteger
beforeAutospacingboolean
beforeLinesinteger
lineinteger
lineRule"auto" | "exact" | "atLeast"
indentobject
Fields
endinteger
endCharsinteger
firstLineinteger
firstLineCharsinteger
hanginginteger
hangingCharsinteger
leftinteger
leftCharsinteger
rightinteger
rightCharsinteger
startinteger
startCharsinteger
shadingobject
Fields
colorstring
fillstring
themeColorstring
themeFillstring
themeFillShadestring
themeFillTintstring
themeShadestring
themeTintstring
valstring
numberingPropertiesobject
Fields
ilvlinteger
numIdinteger
frameProbject
Fields
anchorLockboolean
dropCapstring
hinteger
hAnchorstring
hRulestring
hSpaceinteger
linesinteger
vAnchorstring
vSpaceinteger
winteger
wrapstring
xinteger
xAlignstring
yinteger
yAlignstring
bordersobject
Fields
topobject
bottomobject
leftobject
rightobject
betweenobject
barobject
tabStopsobject[]
Variant 3
targetobjectrequired
Fields
scope"style"required
styleIdstringrequired
channel"run"required
patchobjectrequired
Fields
boldboolean | null
Variant 1

No fields.

Variant 2

No fields.

boldCsboolean | null
Variant 1

No fields.

Variant 2

No fields.

italicboolean | null
Variant 1

No fields.

Variant 2

No fields.

iCsboolean | null
Variant 1

No fields.

Variant 2

No fields.

smallCapsboolean | null
Variant 1

No fields.

Variant 2

No fields.

strikeboolean | null
Variant 1

No fields.

Variant 2

No fields.

dstrikeboolean | null
Variant 1

No fields.

Variant 2

No fields.

embossboolean | null
Variant 1

No fields.

Variant 2

No fields.

imprintboolean | null
Variant 1

No fields.

Variant 2

No fields.

outlineboolean | null
Variant 1

No fields.

Variant 2

No fields.

shadowboolean | null
Variant 1

No fields.

Variant 2

No fields.

vanishboolean | null
Variant 1

No fields.

Variant 2

No fields.

webHiddenboolean | null
Variant 1

No fields.

Variant 2

No fields.

specVanishboolean | null
Variant 1

No fields.

Variant 2

No fields.

snapToGridboolean | null
Variant 1

No fields.

Variant 2

No fields.

noProofboolean | null
Variant 1

No fields.

Variant 2

No fields.

fontSizeinteger | null
Variant 1

No fields.

Variant 2

No fields.

fontSizeCsinteger | null
Variant 1

No fields.

Variant 2

No fields.

letterSpacinginteger | null
Variant 1

No fields.

Variant 2

No fields.

kerninteger | null
Variant 1

No fields.

Variant 2

No fields.

positioninteger | null
Variant 1

No fields.

Variant 2

No fields.

winteger | null
Variant 1

No fields.

Variant 2

No fields.

textTransform"uppercase" | "none" | null
Variant 1

No fields.

Variant 2

No fields.

vertAlign"superscript" | "subscript" | "baseline" | null
Variant 1

No fields.

Variant 2

No fields.

em"none" | "dot" | "comma" | "circle" | "sesame" | null
Variant 1

No fields.

Variant 2

No fields.

effectstring | null
Variant 1

No fields.

Variant 2

No fields.

fontFamilyobject | null
Variant 1
hintstring
asciistring
hAnsistring
eastAsiastring
csstring
valstring
asciiThemestring
hAnsiThemestring
eastAsiaThemestring
csthemestring
Variant 2

No fields.

colorobject | null
Variant 1
valstring
themeColorstring
themeTintstring
themeShadestring
Variant 2

No fields.

underlineobject | null
Variant 1
val"single" | "double" | "thick" | "dotted" | "dottedHeavy" | "dash" | "dashedHeavy" | "dashLong" | "dashLongHeavy" | "dotDash" | "dashDotHeavy" | "dotDotDash" | "dashDotDotHeavy" | "wave" | "wavyHeavy" | "wavyDouble" | "words" | "none"
colorstring
themeColorstring
themeTintstring
themeShadestring
Variant 2

No fields.

bordersobject | null
Variant 1
valstring
colorstring
themeColorstring
themeTintstring
themeShadestring
sizeinteger
spaceinteger
shadowboolean
frameboolean
Variant 2

No fields.

shadingobject | null
Variant 1
colorstring
fillstring
themeColorstring
themeFillstring
themeFillShadestring
themeFillTintstring
themeShadestring
themeTintstring
valstring
Variant 2

No fields.

langobject | null
Variant 1
valstring
eastAsiastring
bidistring
Variant 2

No fields.

eastAsianLayoutobject | null
Variant 1
idinteger
combineboolean
combineBracketsstring
vertboolean
vertCompressboolean
Variant 2

No fields.

fitTextobject | null
Variant 1
valinteger
idinteger
Variant 2

No fields.

csboolean | null
Variant 1

No fields.

Variant 2

No fields.

oMathboolean | null
Variant 1

No fields.

Variant 2

No fields.

rtlboolean | null
Variant 1

No fields.

Variant 2

No fields.

highlight"black" | "blue" | "cyan" | "green" | "magenta" | "red" | "yellow" | "white" | "darkBlue" | "darkCyan" | "darkGreen" | "darkMagenta" | "darkRed" | "darkYellow" | "darkGray" | "lightGray" | "none" | null
Variant 1

No fields.

Variant 2

No fields.

Result

Output fields
true
successtruerequired
appliedChangeMode"direct" | "tracked"
changedbooleanrequired
resolutiondocDefaults | stylerequired
docDefaults
scope"docDefaults"required
channel"run" | "paragraph"required
xmlPartstringrequired
xmlPath"w:styles/w:docDefaults/w:rPrDefault/w:rPr" | "w:styles/w:docDefaults/w:pPrDefault/w:pPr"required
style
scope"style"required
styleIdstringrequired
channel"run"required
xmlPartstringrequired
xmlPath"w:styles/w:style/w:rPr"required
linkedStyleIdstring
dryRunbooleanrequired
beforeobject | objectrequired
Variant 1
bold"on" | "off" | "inherit"
boldCs"on" | "off" | "inherit"
italic"on" | "off" | "inherit"
iCs"on" | "off" | "inherit"
smallCaps"on" | "off" | "inherit"
strike"on" | "off" | "inherit"
dstrike"on" | "off" | "inherit"
emboss"on" | "off" | "inherit"
imprint"on" | "off" | "inherit"
outline"on" | "off" | "inherit"
shadow"on" | "off" | "inherit"
vanish"on" | "off" | "inherit"
webHidden"on" | "off" | "inherit"
specVanish"on" | "off" | "inherit"
snapToGrid"on" | "off" | "inherit"
noProof"on" | "off" | "inherit"
fontSizenumber | "inherit"
Variant 1

No fields.

Variant 2

No fields.

fontSizeCsnumber | "inherit"
Variant 1

No fields.

Variant 2

No fields.

letterSpacingnumber | "inherit"
Variant 1

No fields.

Variant 2

No fields.

kernnumber | "inherit"
Variant 1

No fields.

Variant 2

No fields.

positionnumber | "inherit"
Variant 1

No fields.

Variant 2

No fields.

wnumber | "inherit"
Variant 1

No fields.

Variant 2

No fields.

textTransformstring | "inherit"
Variant 1

No fields.

Variant 2

No fields.

vertAlignstring | "inherit"
Variant 1

No fields.

Variant 2

No fields.

emstring | "inherit"
Variant 1

No fields.

Variant 2

No fields.

effectstring | "inherit"
Variant 1

No fields.

Variant 2

No fields.

fontFamilyobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

colorobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

underlineobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

bordersobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

shadingobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

langobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

eastAsianLayoutobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

fitTextobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

keepLines"on" | "off" | "inherit"
keepNext"on" | "off" | "inherit"
widowControl"on" | "off" | "inherit"
contextualSpacing"on" | "off" | "inherit"
pageBreakBefore"on" | "off" | "inherit"
suppressAutoHyphens"on" | "off" | "inherit"
suppressLineNumbers"on" | "off" | "inherit"
suppressOverlap"on" | "off" | "inherit"
mirrorIndents"on" | "off" | "inherit"
wordWrap"on" | "off" | "inherit"
kinsoku"on" | "off" | "inherit"
overflowPunct"on" | "off" | "inherit"
topLinePunct"on" | "off" | "inherit"
autoSpaceDE"on" | "off" | "inherit"
autoSpaceDN"on" | "off" | "inherit"
adjustRightInd"on" | "off" | "inherit"
rightToLeft"on" | "off" | "inherit"
outlineLvlnumber | "inherit"
Variant 1

No fields.

Variant 2

No fields.

justificationstring | "inherit"
Variant 1

No fields.

Variant 2

No fields.

textAlignmentstring | "inherit"
Variant 1

No fields.

Variant 2

No fields.

textDirectionstring | "inherit"
Variant 1

No fields.

Variant 2

No fields.

textboxTightWrapstring | "inherit"
Variant 1

No fields.

Variant 2

No fields.

spacingobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

indentobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

numberingPropertiesobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

frameProbject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

tabStopsunknown[] | "inherit"
Variant 1

No fields.

Variant 2

No fields.

Variant 2
bold"on" | "off" | "inherit"
boldCs"on" | "off" | "inherit"
italic"on" | "off" | "inherit"
iCs"on" | "off" | "inherit"
smallCaps"on" | "off" | "inherit"
strike"on" | "off" | "inherit"
dstrike"on" | "off" | "inherit"
emboss"on" | "off" | "inherit"
imprint"on" | "off" | "inherit"
outline"on" | "off" | "inherit"
shadow"on" | "off" | "inherit"
vanish"on" | "off" | "inherit"
webHidden"on" | "off" | "inherit"
specVanish"on" | "off" | "inherit"
snapToGrid"on" | "off" | "inherit"
noProof"on" | "off" | "inherit"
fontSizenumber | "inherit"
Variant 1

No fields.

Variant 2

No fields.

fontSizeCsnumber | "inherit"
Variant 1

No fields.

Variant 2

No fields.

letterSpacingnumber | "inherit"
Variant 1

No fields.

Variant 2

No fields.

kernnumber | "inherit"
Variant 1

No fields.

Variant 2

No fields.

positionnumber | "inherit"
Variant 1

No fields.

Variant 2

No fields.

wnumber | "inherit"
Variant 1

No fields.

Variant 2

No fields.

textTransformstring | "inherit"
Variant 1

No fields.

Variant 2

No fields.

vertAlignstring | "inherit"
Variant 1

No fields.

Variant 2

No fields.

emstring | "inherit"
Variant 1

No fields.

Variant 2

No fields.

effectstring | "inherit"
Variant 1

No fields.

Variant 2

No fields.

fontFamilyobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

colorobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

underlineobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

bordersobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

shadingobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

langobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

eastAsianLayoutobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

fitTextobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

cs"on" | "off" | "inherit"
oMath"on" | "off" | "inherit"
rtl"on" | "off" | "inherit"
highlightstring | "inherit"
Variant 1

No fields.

Variant 2

No fields.

afterobject | objectrequired
Variant 1
bold"on" | "off" | "inherit"
boldCs"on" | "off" | "inherit"
italic"on" | "off" | "inherit"
iCs"on" | "off" | "inherit"
smallCaps"on" | "off" | "inherit"
strike"on" | "off" | "inherit"
dstrike"on" | "off" | "inherit"
emboss"on" | "off" | "inherit"
imprint"on" | "off" | "inherit"
outline"on" | "off" | "inherit"
shadow"on" | "off" | "inherit"
vanish"on" | "off" | "inherit"
webHidden"on" | "off" | "inherit"
specVanish"on" | "off" | "inherit"
snapToGrid"on" | "off" | "inherit"
noProof"on" | "off" | "inherit"
fontSizenumber | "inherit"
Variant 1

No fields.

Variant 2

No fields.

fontSizeCsnumber | "inherit"
Variant 1

No fields.

Variant 2

No fields.

letterSpacingnumber | "inherit"
Variant 1

No fields.

Variant 2

No fields.

kernnumber | "inherit"
Variant 1

No fields.

Variant 2

No fields.

positionnumber | "inherit"
Variant 1

No fields.

Variant 2

No fields.

wnumber | "inherit"
Variant 1

No fields.

Variant 2

No fields.

textTransformstring | "inherit"
Variant 1

No fields.

Variant 2

No fields.

vertAlignstring | "inherit"
Variant 1

No fields.

Variant 2

No fields.

emstring | "inherit"
Variant 1

No fields.

Variant 2

No fields.

effectstring | "inherit"
Variant 1

No fields.

Variant 2

No fields.

fontFamilyobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

colorobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

underlineobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

bordersobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

shadingobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

langobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

eastAsianLayoutobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

fitTextobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

keepLines"on" | "off" | "inherit"
keepNext"on" | "off" | "inherit"
widowControl"on" | "off" | "inherit"
contextualSpacing"on" | "off" | "inherit"
pageBreakBefore"on" | "off" | "inherit"
suppressAutoHyphens"on" | "off" | "inherit"
suppressLineNumbers"on" | "off" | "inherit"
suppressOverlap"on" | "off" | "inherit"
mirrorIndents"on" | "off" | "inherit"
wordWrap"on" | "off" | "inherit"
kinsoku"on" | "off" | "inherit"
overflowPunct"on" | "off" | "inherit"
topLinePunct"on" | "off" | "inherit"
autoSpaceDE"on" | "off" | "inherit"
autoSpaceDN"on" | "off" | "inherit"
adjustRightInd"on" | "off" | "inherit"
rightToLeft"on" | "off" | "inherit"
outlineLvlnumber | "inherit"
Variant 1

No fields.

Variant 2

No fields.

justificationstring | "inherit"
Variant 1

No fields.

Variant 2

No fields.

textAlignmentstring | "inherit"
Variant 1

No fields.

Variant 2

No fields.

textDirectionstring | "inherit"
Variant 1

No fields.

Variant 2

No fields.

textboxTightWrapstring | "inherit"
Variant 1

No fields.

Variant 2

No fields.

spacingobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

indentobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

numberingPropertiesobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

frameProbject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

tabStopsunknown[] | "inherit"
Variant 1

No fields.

Variant 2

No fields.

Variant 2
bold"on" | "off" | "inherit"
boldCs"on" | "off" | "inherit"
italic"on" | "off" | "inherit"
iCs"on" | "off" | "inherit"
smallCaps"on" | "off" | "inherit"
strike"on" | "off" | "inherit"
dstrike"on" | "off" | "inherit"
emboss"on" | "off" | "inherit"
imprint"on" | "off" | "inherit"
outline"on" | "off" | "inherit"
shadow"on" | "off" | "inherit"
vanish"on" | "off" | "inherit"
webHidden"on" | "off" | "inherit"
specVanish"on" | "off" | "inherit"
snapToGrid"on" | "off" | "inherit"
noProof"on" | "off" | "inherit"
fontSizenumber | "inherit"
Variant 1

No fields.

Variant 2

No fields.

fontSizeCsnumber | "inherit"
Variant 1

No fields.

Variant 2

No fields.

letterSpacingnumber | "inherit"
Variant 1

No fields.

Variant 2

No fields.

kernnumber | "inherit"
Variant 1

No fields.

Variant 2

No fields.

positionnumber | "inherit"
Variant 1

No fields.

Variant 2

No fields.

wnumber | "inherit"
Variant 1

No fields.

Variant 2

No fields.

textTransformstring | "inherit"
Variant 1

No fields.

Variant 2

No fields.

vertAlignstring | "inherit"
Variant 1

No fields.

Variant 2

No fields.

emstring | "inherit"
Variant 1

No fields.

Variant 2

No fields.

effectstring | "inherit"
Variant 1

No fields.

Variant 2

No fields.

fontFamilyobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

colorobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

underlineobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

bordersobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

shadingobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

langobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

eastAsianLayoutobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

fitTextobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

cs"on" | "off" | "inherit"
oMath"on" | "off" | "inherit"
rtl"on" | "off" | "inherit"
highlightstring | "inherit"
Variant 1

No fields.

Variant 2

No fields.

false
successfalserequired
resolutiondocDefaults | stylerequired
docDefaults
scope"docDefaults"required
channel"run" | "paragraph"required
xmlPartstringrequired
xmlPath"w:styles/w:docDefaults/w:rPrDefault/w:rPr" | "w:styles/w:docDefaults/w:pPrDefault/w:pPr"required
style
scope"style"required
styleIdstringrequired
channel"run"required
xmlPartstringrequired
xmlPath"w:styles/w:style/w:rPr"required
linkedStyleIdstring
failureobjectrequired
Fields
codestringrequired
messagestringrequired
detailsunknown

Failures

Pre-apply throws

  • INVALID_TARGET
  • INVALID_INPUT
  • CAPABILITY_UNAVAILABLE
1 more codes
  • REVISION_MISMATCH

Non-applied receipt codes

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