set-style.mdx

title	styles.paragraph.setStyle
sidebarTitle	styles.paragraph.setStyle
description	Apply a paragraph style (w:pStyle) to a paragraph-like block, clearing direct run formatting while preserving character-style references.

{/* GENERATED FILE: DO NOT EDIT. Regenerate via pnpm run docapi:sync. */}

Summary

Apply a paragraph style (w:pStyle) to a paragraph-like block, clearing direct run formatting while preserving character-style references.

• Operation ID: styles.paragraph.setStyle
• API member path: editor.doc.styles.paragraph.setStyle(...)
• Mutates document: yes
• Idempotency: conditional
• Supports tracked mode: no
• Supports dry run: yes
• Deterministic target resolution: yes

Expected result

Returns a ParagraphMutationResult; reports NO_OP if the style already matches. When the style changes, direct run formatting is cleared while character-style references are preserved.

Input fields

Field	Type	Required	Description
styleId	string	yes
target	ParagraphAddress | HeadingAddress | ListItemAddress	yes	One of: ParagraphAddress, HeadingAddress, ListItemAddress

Example request

{
  "styleId": "style-001",
  "target": {
    "kind": "block",
    "nodeId": "node-def456",
    "nodeType": "paragraph"
  }
}

Output fields

Variant 1 (success=true)

Field	Type	Required	Description
resolution	object	yes
resolution.target	ParagraphAddress | HeadingAddress | ListItemAddress	yes	One of: ParagraphAddress, HeadingAddress, ListItemAddress
success	true	yes	Constant: true
target	ParagraphAddress | HeadingAddress | ListItemAddress	yes	One of: ParagraphAddress, HeadingAddress, ListItemAddress

Variant 2 (success=false)

Field	Type	Required	Description
failure	object	yes
failure.code	enum	yes	"NO_OP"
failure.details	any	no
failure.message	string	yes
resolution	object	no
resolution.target	ParagraphAddress | HeadingAddress | ListItemAddress	no	One of: ParagraphAddress, HeadingAddress, ListItemAddress
success	false	yes	Constant: false

Example response

{
  "resolution": {
    "target": {
      "kind": "block",
      "nodeId": "node-def456",
      "nodeType": "paragraph"
    }
  },
  "success": true,
  "target": {
    "kind": "block",
    "nodeId": "node-def456",
    "nodeType": "paragraph"
  }
}

Pre-apply throws

• TARGET_NOT_FOUND
• INVALID_TARGET
• CAPABILITY_UNAVAILABLE

Non-applied failure codes

• NO_OP

Raw schemas

```json { "additionalProperties": false, "properties": { "styleId": { "description": "Named paragraph style ID (e.g. 'Normal', 'Heading1', 'BodyText'). Use superdoc_search to find a nearby paragraph, then inspect its style to determine the correct styleId.", "minLength": 1, "type": "string" }, "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "required": [ "target", "styleId" ], "type": "object" } ``` ```json { "oneOf": [ { "additionalProperties": false, "properties": { "resolution": { "additionalProperties": false, "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "required": [ "target" ], "type": "object" }, "success": { "const": true }, "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "required": [ "success", "target", "resolution" ], "type": "object" }, { "additionalProperties": false, "properties": { "failure": { "additionalProperties": false, "properties": { "code": { "enum": [ "NO_OP" ] }, "details": {}, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" }, "resolution": { "additionalProperties": false, "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "required": [ "target" ], "type": "object" }, "success": { "const": false } }, "required": [ "success", "failure" ], "type": "object" } ] } ``` ```json { "additionalProperties": false, "properties": { "resolution": { "additionalProperties": false, "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "required": [ "target" ], "type": "object" }, "success": { "const": true }, "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "required": [ "success", "target", "resolution" ], "type": "object" } ``` ```json { "additionalProperties": false, "properties": { "failure": { "additionalProperties": false, "properties": { "code": { "enum": [ "NO_OP" ] }, "details": {}, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" }, "resolution": { "additionalProperties": false, "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "required": [ "target" ], "type": "object" }, "success": { "const": false } }, "required": [ "success", "failure" ], "type": "object" } ```