# styles.apply > Apply document-level default style changes to the stylesheet (word/styles.xml). Targets docDefaults run and paragraph channels with set-style patch semantics. - Member path: `doc.styles.apply(…)` - Mutates document: yes - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: yes ## Expected result Returns a StylesApplyReceipt with per-channel success/failure details for each property change. ## Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "target": { "type": "object", "properties": { "scope": { "const": "docDefaults" }, "channel": { "const": "run" } }, "additionalProperties": false, "required": [ "scope", "channel" ] }, "patch": { "type": "object", "properties": { "bold": { "type": "boolean" }, "boldCs": { "type": "boolean" }, "italic": { "type": "boolean" }, "iCs": { "type": "boolean" }, "smallCaps": { "type": "boolean" }, "strike": { "type": "boolean" }, "dstrike": { "type": "boolean" }, "emboss": { "type": "boolean" }, "imprint": { "type": "boolean" }, "outline": { "type": "boolean" }, "shadow": { "type": "boolean" }, "vanish": { "type": "boolean" }, "webHidden": { "type": "boolean" }, "specVanish": { "type": "boolean" }, "snapToGrid": { "type": "boolean" }, "noProof": { "type": "boolean" }, "fontSize": { "type": "integer" }, "fontSizeCs": { "type": "integer" }, "letterSpacing": { "type": "integer" }, "kern": { "type": "integer" }, "position": { "type": "integer" }, "w": { "type": "integer", "minimum": 1, "maximum": 600 }, "textTransform": { "enum": [ "uppercase", "none" ] }, "vertAlign": { "enum": [ "superscript", "subscript", "baseline" ] }, "em": { "enum": [ "none", "dot", "comma", "circle", "sesame" ] }, "effect": { "type": "string", "minLength": 1 }, "fontFamily": { "type": "object", "properties": { "hint": { "type": "string", "minLength": 1 }, "ascii": { "type": "string", "minLength": 1 }, "hAnsi": { "type": "string", "minLength": 1 }, "eastAsia": { "type": "string", "minLength": 1 }, "cs": { "type": "string", "minLength": 1 }, "val": { "type": "string", "minLength": 1 }, "asciiTheme": { "type": "string", "minLength": 1 }, "hAnsiTheme": { "type": "string", "minLength": 1 }, "eastAsiaTheme": { "type": "string", "minLength": 1 }, "cstheme": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "minProperties": 1 }, "color": { "type": "object", "properties": { "val": { "type": "string", "minLength": 1 }, "themeColor": { "type": "string", "minLength": 1 }, "themeTint": { "type": "string", "minLength": 1 }, "themeShade": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "minProperties": 1 }, "underline": { "type": "object", "properties": { "val": { "enum": [ "single", "double", "thick", "dotted", "dottedHeavy", "dash", "dashedHeavy", "dashLong", "dashLongHeavy", "dotDash", "dashDotHeavy", "dotDotDash", "dashDotDotHeavy", "wave", "wavyHeavy", "wavyDouble", "words", "none" ] }, "color": { "type": "string", "minLength": 1 }, "themeColor": { "type": "string", "minLength": 1 }, "themeTint": { "type": "string", "minLength": 1 }, "themeShade": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "minProperties": 1 }, "borders": { "type": "object", "properties": { "val": { "type": "string", "minLength": 1 }, "color": { "type": "string", "minLength": 1 }, "themeColor": { "type": "string", "minLength": 1 }, "themeTint": { "type": "string", "minLength": 1 }, "themeShade": { "type": "string", "minLength": 1 }, "size": { "type": "integer" }, "space": { "type": "integer" }, "shadow": { "type": "boolean" }, "frame": { "type": "boolean" } }, "additionalProperties": false, "minProperties": 1 }, "shading": { "type": "object", "properties": { "color": { "type": "string", "minLength": 1 }, "fill": { "type": "string", "minLength": 1 }, "themeColor": { "type": "string", "minLength": 1 }, "themeFill": { "type": "string", "minLength": 1 }, "themeFillShade": { "type": "string", "minLength": 1 }, "themeFillTint": { "type": "string", "minLength": 1 }, "themeShade": { "type": "string", "minLength": 1 }, "themeTint": { "type": "string", "minLength": 1 }, "val": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "minProperties": 1 }, "lang": { "type": "object", "properties": { "val": { "type": "string", "minLength": 1 }, "eastAsia": { "type": "string", "minLength": 1 }, "bidi": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "minProperties": 1 }, "eastAsianLayout": { "type": "object", "properties": { "id": { "type": "integer" }, "combine": { "type": "boolean" }, "combineBrackets": { "type": "string", "minLength": 1 }, "vert": { "type": "boolean" }, "vertCompress": { "type": "boolean" } }, "additionalProperties": false, "minProperties": 1 }, "fitText": { "type": "object", "properties": { "val": { "type": "integer" }, "id": { "type": "integer" } }, "additionalProperties": false, "minProperties": 1 } }, "additionalProperties": false, "minProperties": 1 } }, "additionalProperties": false, "required": [ "target", "patch" ] }, { "type": "object", "properties": { "target": { "type": "object", "properties": { "scope": { "const": "docDefaults" }, "channel": { "const": "paragraph" } }, "additionalProperties": false, "required": [ "scope", "channel" ] }, "patch": { "type": "object", "properties": { "keepLines": { "type": "boolean" }, "keepNext": { "type": "boolean" }, "widowControl": { "type": "boolean" }, "contextualSpacing": { "type": "boolean" }, "pageBreakBefore": { "type": "boolean" }, "suppressAutoHyphens": { "type": "boolean" }, "suppressLineNumbers": { "type": "boolean" }, "suppressOverlap": { "type": "boolean" }, "mirrorIndents": { "type": "boolean" }, "wordWrap": { "type": "boolean" }, "kinsoku": { "type": "boolean" }, "overflowPunct": { "type": "boolean" }, "topLinePunct": { "type": "boolean" }, "autoSpaceDE": { "type": "boolean" }, "autoSpaceDN": { "type": "boolean" }, "adjustRightInd": { "type": "boolean" }, "rightToLeft": { "type": "boolean" }, "snapToGrid": { "type": "boolean" }, "outlineLvl": { "type": "integer", "minimum": 0, "maximum": 9 }, "justification": { "enum": [ "left", "center", "right", "justify", "distribute" ] }, "textAlignment": { "enum": [ "top", "center", "baseline", "bottom", "auto" ] }, "textDirection": { "enum": [ "lrTb", "tbRl", "btLr", "lrTbV", "tbRlV", "tbLrV" ] }, "textboxTightWrap": { "enum": [ "none", "allLines", "firstAndLastLine", "firstLineOnly", "lastLineOnly" ] }, "spacing": { "type": "object", "properties": { "after": { "type": "integer" }, "afterAutospacing": { "type": "boolean" }, "afterLines": { "type": "integer" }, "before": { "type": "integer" }, "beforeAutospacing": { "type": "boolean" }, "beforeLines": { "type": "integer" }, "line": { "type": "integer" }, "lineRule": { "enum": [ "auto", "exact", "atLeast" ] } }, "additionalProperties": false, "minProperties": 1 }, "indent": { "type": "object", "properties": { "end": { "type": "integer" }, "endChars": { "type": "integer" }, "firstLine": { "type": "integer" }, "firstLineChars": { "type": "integer" }, "hanging": { "type": "integer" }, "hangingChars": { "type": "integer" }, "left": { "type": "integer" }, "leftChars": { "type": "integer" }, "right": { "type": "integer" }, "rightChars": { "type": "integer" }, "start": { "type": "integer" }, "startChars": { "type": "integer" } }, "additionalProperties": false, "minProperties": 1 }, "shading": { "type": "object", "properties": { "color": { "type": "string", "minLength": 1 }, "fill": { "type": "string", "minLength": 1 }, "themeColor": { "type": "string", "minLength": 1 }, "themeFill": { "type": "string", "minLength": 1 }, "themeFillShade": { "type": "string", "minLength": 1 }, "themeFillTint": { "type": "string", "minLength": 1 }, "themeShade": { "type": "string", "minLength": 1 }, "themeTint": { "type": "string", "minLength": 1 }, "val": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "minProperties": 1 }, "numberingProperties": { "type": "object", "properties": { "ilvl": { "type": "integer" }, "numId": { "type": "integer" } }, "additionalProperties": false, "minProperties": 1 }, "framePr": { "type": "object", "properties": { "anchorLock": { "type": "boolean" }, "dropCap": { "type": "string", "minLength": 1 }, "h": { "type": "integer" }, "hAnchor": { "type": "string", "minLength": 1 }, "hRule": { "type": "string", "minLength": 1 }, "hSpace": { "type": "integer" }, "lines": { "type": "integer" }, "vAnchor": { "type": "string", "minLength": 1 }, "vSpace": { "type": "integer" }, "w": { "type": "integer" }, "wrap": { "type": "string", "minLength": 1 }, "x": { "type": "integer" }, "xAlign": { "type": "string", "minLength": 1 }, "y": { "type": "integer" }, "yAlign": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "minProperties": 1 }, "borders": { "type": "object", "properties": { "top": { "type": "object", "properties": { "val": { "type": "string", "minLength": 1 }, "color": { "type": "string", "minLength": 1 }, "themeColor": { "type": "string", "minLength": 1 }, "themeTint": { "type": "string", "minLength": 1 }, "themeShade": { "type": "string", "minLength": 1 }, "size": { "type": "integer" }, "space": { "type": "integer" }, "shadow": { "type": "boolean" }, "frame": { "type": "boolean" } }, "additionalProperties": false, "minProperties": 1 }, "bottom": { "type": "object", "properties": { "val": { "type": "string", "minLength": 1 }, "color": { "type": "string", "minLength": 1 }, "themeColor": { "type": "string", "minLength": 1 }, "themeTint": { "type": "string", "minLength": 1 }, "themeShade": { "type": "string", "minLength": 1 }, "size": { "type": "integer" }, "space": { "type": "integer" }, "shadow": { "type": "boolean" }, "frame": { "type": "boolean" } }, "additionalProperties": false, "minProperties": 1 }, "left": { "type": "object", "properties": { "val": { "type": "string", "minLength": 1 }, "color": { "type": "string", "minLength": 1 }, "themeColor": { "type": "string", "minLength": 1 }, "themeTint": { "type": "string", "minLength": 1 }, "themeShade": { "type": "string", "minLength": 1 }, "size": { "type": "integer" }, "space": { "type": "integer" }, "shadow": { "type": "boolean" }, "frame": { "type": "boolean" } }, "additionalProperties": false, "minProperties": 1 }, "right": { "type": "object", "properties": { "val": { "type": "string", "minLength": 1 }, "color": { "type": "string", "minLength": 1 }, "themeColor": { "type": "string", "minLength": 1 }, "themeTint": { "type": "string", "minLength": 1 }, "themeShade": { "type": "string", "minLength": 1 }, "size": { "type": "integer" }, "space": { "type": "integer" }, "shadow": { "type": "boolean" }, "frame": { "type": "boolean" } }, "additionalProperties": false, "minProperties": 1 }, "between": { "type": "object", "properties": { "val": { "type": "string", "minLength": 1 }, "color": { "type": "string", "minLength": 1 }, "themeColor": { "type": "string", "minLength": 1 }, "themeTint": { "type": "string", "minLength": 1 }, "themeShade": { "type": "string", "minLength": 1 }, "size": { "type": "integer" }, "space": { "type": "integer" }, "shadow": { "type": "boolean" }, "frame": { "type": "boolean" } }, "additionalProperties": false, "minProperties": 1 }, "bar": { "type": "object", "properties": { "val": { "type": "string", "minLength": 1 }, "color": { "type": "string", "minLength": 1 }, "themeColor": { "type": "string", "minLength": 1 }, "themeTint": { "type": "string", "minLength": 1 }, "themeShade": { "type": "string", "minLength": 1 }, "size": { "type": "integer" }, "space": { "type": "integer" }, "shadow": { "type": "boolean" }, "frame": { "type": "boolean" } }, "additionalProperties": false, "minProperties": 1 } }, "additionalProperties": false, "minProperties": 1 }, "tabStops": { "type": "array", "items": { "type": "object", "properties": { "tab": { "type": "object", "properties": { "tabType": { "type": "string", "minLength": 1 }, "pos": { "type": "integer" }, "leader": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "minProperties": 1 } }, "additionalProperties": false, "minProperties": 1 } } }, "additionalProperties": false, "minProperties": 1 } }, "additionalProperties": false, "required": [ "target", "patch" ] } ] } ``` ## Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "changed": { "type": "boolean" }, "resolution": { "type": "object", "properties": { "scope": { "const": "docDefaults" }, "channel": { "enum": [ "run", "paragraph" ] }, "xmlPart": { "const": "word/styles.xml" }, "xmlPath": { "enum": [ "w:styles/w:docDefaults/w:rPrDefault/w:rPr", "w:styles/w:docDefaults/w:pPrDefault/w:pPr" ] } }, "additionalProperties": false, "required": [ "scope", "channel", "xmlPart", "xmlPath" ] }, "dryRun": { "type": "boolean" }, "before": { "type": "object", "properties": { "bold": { "enum": [ "on", "off", "inherit" ] }, "boldCs": { "enum": [ "on", "off", "inherit" ] }, "italic": { "enum": [ "on", "off", "inherit" ] }, "iCs": { "enum": [ "on", "off", "inherit" ] }, "smallCaps": { "enum": [ "on", "off", "inherit" ] }, "strike": { "enum": [ "on", "off", "inherit" ] }, "dstrike": { "enum": [ "on", "off", "inherit" ] }, "emboss": { "enum": [ "on", "off", "inherit" ] }, "imprint": { "enum": [ "on", "off", "inherit" ] }, "outline": { "enum": [ "on", "off", "inherit" ] }, "shadow": { "enum": [ "on", "off", "inherit" ] }, "vanish": { "enum": [ "on", "off", "inherit" ] }, "webHidden": { "enum": [ "on", "off", "inherit" ] }, "specVanish": { "enum": [ "on", "off", "inherit" ] }, "snapToGrid": { "enum": [ "on", "off", "inherit" ] }, "noProof": { "enum": [ "on", "off", "inherit" ] }, "fontSize": { "oneOf": [ { "type": "number" }, { "const": "inherit" } ] }, "fontSizeCs": { "oneOf": [ { "type": "number" }, { "const": "inherit" } ] }, "letterSpacing": { "oneOf": [ { "type": "number" }, { "const": "inherit" } ] }, "kern": { "oneOf": [ { "type": "number" }, { "const": "inherit" } ] }, "position": { "oneOf": [ { "type": "number" }, { "const": "inherit" } ] }, "w": { "oneOf": [ { "type": "number" }, { "const": "inherit" } ] }, "textTransform": { "oneOf": [ { "type": "string" }, { "const": "inherit" } ] }, "vertAlign": { "oneOf": [ { "type": "string" }, { "const": "inherit" } ] }, "em": { "oneOf": [ { "type": "string" }, { "const": "inherit" } ] }, "effect": { "oneOf": [ { "type": "string" }, { "const": "inherit" } ] }, "fontFamily": { "oneOf": [ { "type": "object" }, { "const": "inherit" } ] }, "color": { "oneOf": [ { "type": "object" }, { "const": "inherit" } ] }, "underline": { "oneOf": [ { "type": "object" }, { "const": "inherit" } ] }, "borders": { "oneOf": [ { "type": "object" }, { "const": "inherit" } ] }, "shading": { "oneOf": [ { "type": "object" }, { "const": "inherit" } ] }, "lang": { "oneOf": [ { "type": "object" }, { "const": "inherit" } ] }, "eastAsianLayout": { "oneOf": [ { "type": "object" }, { "const": "inherit" } ] }, "fitText": { "oneOf": [ { "type": "object" }, { "const": "inherit" } ] }, "keepLines": { "enum": [ "on", "off", "inherit" ] }, "keepNext": { "enum": [ "on", "off", "inherit" ] }, "widowControl": { "enum": [ "on", "off", "inherit" ] }, "contextualSpacing": { "enum": [ "on", "off", "inherit" ] }, "pageBreakBefore": { "enum": [ "on", "off", "inherit" ] }, "suppressAutoHyphens": { "enum": [ "on", "off", "inherit" ] }, "suppressLineNumbers": { "enum": [ "on", "off", "inherit" ] }, "suppressOverlap": { "enum": [ "on", "off", "inherit" ] }, "mirrorIndents": { "enum": [ "on", "off", "inherit" ] }, "wordWrap": { "enum": [ "on", "off", "inherit" ] }, "kinsoku": { "enum": [ "on", "off", "inherit" ] }, "overflowPunct": { "enum": [ "on", "off", "inherit" ] }, "topLinePunct": { "enum": [ "on", "off", "inherit" ] }, "autoSpaceDE": { "enum": [ "on", "off", "inherit" ] }, "autoSpaceDN": { "enum": [ "on", "off", "inherit" ] }, "adjustRightInd": { "enum": [ "on", "off", "inherit" ] }, "rightToLeft": { "enum": [ "on", "off", "inherit" ] }, "outlineLvl": { "oneOf": [ { "type": "number" }, { "const": "inherit" } ] }, "justification": { "oneOf": [ { "type": "string" }, { "const": "inherit" } ] }, "textAlignment": { "oneOf": [ { "type": "string" }, { "const": "inherit" } ] }, "textDirection": { "oneOf": [ { "type": "string" }, { "const": "inherit" } ] }, "textboxTightWrap": { "oneOf": [ { "type": "string" }, { "const": "inherit" } ] }, "spacing": { "oneOf": [ { "type": "object" }, { "const": "inherit" } ] }, "indent": { "oneOf": [ { "type": "object" }, { "const": "inherit" } ] }, "numberingProperties": { "oneOf": [ { "type": "object" }, { "const": "inherit" } ] }, "framePr": { "oneOf": [ { "type": "object" }, { "const": "inherit" } ] }, "tabStops": { "oneOf": [ { "type": "array" }, { "const": "inherit" } ] } }, "additionalProperties": false }, "after": { "type": "object", "properties": { "bold": { "enum": [ "on", "off", "inherit" ] }, "boldCs": { "enum": [ "on", "off", "inherit" ] }, "italic": { "enum": [ "on", "off", "inherit" ] }, "iCs": { "enum": [ "on", "off", "inherit" ] }, "smallCaps": { "enum": [ "on", "off", "inherit" ] }, "strike": { "enum": [ "on", "off", "inherit" ] }, "dstrike": { "enum": [ "on", "off", "inherit" ] }, "emboss": { "enum": [ "on", "off", "inherit" ] }, "imprint": { "enum": [ "on", "off", "inherit" ] }, "outline": { "enum": [ "on", "off", "inherit" ] }, "shadow": { "enum": [ "on", "off", "inherit" ] }, "vanish": { "enum": [ "on", "off", "inherit" ] }, "webHidden": { "enum": [ "on", "off", "inherit" ] }, "specVanish": { "enum": [ "on", "off", "inherit" ] }, "snapToGrid": { "enum": [ "on", "off", "inherit" ] }, "noProof": { "enum": [ "on", "off", "inherit" ] }, "fontSize": { "oneOf": [ { "type": "number" }, { "const": "inherit" } ] }, "fontSizeCs": { "oneOf": [ { "type": "number" }, { "const": "inherit" } ] }, "letterSpacing": { "oneOf": [ { "type": "number" }, { "const": "inherit" } ] }, "kern": { "oneOf": [ { "type": "number" }, { "const": "inherit" } ] }, "position": { "oneOf": [ { "type": "number" }, { "const": "inherit" } ] }, "w": { "oneOf": [ { "type": "number" }, { "const": "inherit" } ] }, "textTransform": { "oneOf": [ { "type": "string" }, { "const": "inherit" } ] }, "vertAlign": { "oneOf": [ { "type": "string" }, { "const": "inherit" } ] }, "em": { "oneOf": [ { "type": "string" }, { "const": "inherit" } ] }, "effect": { "oneOf": [ { "type": "string" }, { "const": "inherit" } ] }, "fontFamily": { "oneOf": [ { "type": "object" }, { "const": "inherit" } ] }, "color": { "oneOf": [ { "type": "object" }, { "const": "inherit" } ] }, "underline": { "oneOf": [ { "type": "object" }, { "const": "inherit" } ] }, "borders": { "oneOf": [ { "type": "object" }, { "const": "inherit" } ] }, "shading": { "oneOf": [ { "type": "object" }, { "const": "inherit" } ] }, "lang": { "oneOf": [ { "type": "object" }, { "const": "inherit" } ] }, "eastAsianLayout": { "oneOf": [ { "type": "object" }, { "const": "inherit" } ] }, "fitText": { "oneOf": [ { "type": "object" }, { "const": "inherit" } ] }, "keepLines": { "enum": [ "on", "off", "inherit" ] }, "keepNext": { "enum": [ "on", "off", "inherit" ] }, "widowControl": { "enum": [ "on", "off", "inherit" ] }, "contextualSpacing": { "enum": [ "on", "off", "inherit" ] }, "pageBreakBefore": { "enum": [ "on", "off", "inherit" ] }, "suppressAutoHyphens": { "enum": [ "on", "off", "inherit" ] }, "suppressLineNumbers": { "enum": [ "on", "off", "inherit" ] }, "suppressOverlap": { "enum": [ "on", "off", "inherit" ] }, "mirrorIndents": { "enum": [ "on", "off", "inherit" ] }, "wordWrap": { "enum": [ "on", "off", "inherit" ] }, "kinsoku": { "enum": [ "on", "off", "inherit" ] }, "overflowPunct": { "enum": [ "on", "off", "inherit" ] }, "topLinePunct": { "enum": [ "on", "off", "inherit" ] }, "autoSpaceDE": { "enum": [ "on", "off", "inherit" ] }, "autoSpaceDN": { "enum": [ "on", "off", "inherit" ] }, "adjustRightInd": { "enum": [ "on", "off", "inherit" ] }, "rightToLeft": { "enum": [ "on", "off", "inherit" ] }, "outlineLvl": { "oneOf": [ { "type": "number" }, { "const": "inherit" } ] }, "justification": { "oneOf": [ { "type": "string" }, { "const": "inherit" } ] }, "textAlignment": { "oneOf": [ { "type": "string" }, { "const": "inherit" } ] }, "textDirection": { "oneOf": [ { "type": "string" }, { "const": "inherit" } ] }, "textboxTightWrap": { "oneOf": [ { "type": "string" }, { "const": "inherit" } ] }, "spacing": { "oneOf": [ { "type": "object" }, { "const": "inherit" } ] }, "indent": { "oneOf": [ { "type": "object" }, { "const": "inherit" } ] }, "numberingProperties": { "oneOf": [ { "type": "object" }, { "const": "inherit" } ] }, "framePr": { "oneOf": [ { "type": "object" }, { "const": "inherit" } ] }, "tabStops": { "oneOf": [ { "type": "array" }, { "const": "inherit" } ] } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "success", "changed", "resolution", "dryRun", "before", "after" ] }, { "type": "object", "properties": { "success": { "const": false }, "resolution": { "type": "object", "properties": { "scope": { "const": "docDefaults" }, "channel": { "enum": [ "run", "paragraph" ] }, "xmlPart": { "const": "word/styles.xml" }, "xmlPath": { "enum": [ "w:styles/w:docDefaults/w:rPrDefault/w:rPr", "w:styles/w:docDefaults/w:pPrDefault/w:pPr" ] } }, "additionalProperties": false, "required": [ "scope", "channel", "xmlPart", "xmlPath" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "resolution", "failure" ] } ] } ``` ## Pre-apply throws - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` - `REVISION_MISMATCH` ## Non-applied receipt codes - None