> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superdoc.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# format.apply

> Apply inline run-property patch changes to the target range with explicit set/clear semantics.

## Summary

Apply inline run-property patch changes to the target range with explicit set/clear semantics.

* Operation ID: `format.apply`
* API member path: `editor.doc.format.apply(...)`
* Mutates document: `yes`
* Idempotency: `conditional`
* Supports tracked mode: `yes`
* Supports dry run: `yes`
* Deterministic target resolution: `yes`

## Expected result

Returns a TextMutationReceipt confirming inline styles were applied to the target range.

## Input fields

### Variant 1 (target.kind="selection")

| Field | Type | Required | Description |
| - | - | - | - |
| `in` | StoryLocator | no | StoryLocator |
| `inline` | object | yes | |
| `inline.bCs` | boolean \| null | no | One of: boolean, null |
| `inline.bold` | boolean \| null | no | One of: boolean, null |
| `inline.border` | object \| null | no | One of: object, null |
| `inline.caps` | boolean \| null | no | One of: boolean, null |
| `inline.charScale` | number \| null | no | One of: number, null |
| `inline.color` | string \| null | no | One of: string, null |
| `inline.contextualAlternates` | boolean \| null | no | One of: boolean, null |
| `inline.cs` | boolean \| null | no | One of: boolean, null |
| `inline.dstrike` | boolean \| null | no | One of: boolean, null |
| `inline.eastAsianLayout` | object \| null | no | One of: object, null |
| `inline.em` | string \| null | no | One of: string, null |
| `inline.emboss` | boolean \| null | no | One of: boolean, null |
| `inline.fitText` | object \| null | no | One of: object, null |
| `inline.fontFamily` | string \| null | no | One of: string, null |
| `inline.fontSize` | number \| null | no | One of: number, null |
| `inline.fontSizeCs` | number \| null | no | One of: number, null |
| `inline.highlight` | string \| null | no | One of: string, null |
| `inline.iCs` | boolean \| null | no | One of: boolean, null |
| `inline.imprint` | boolean \| null | no | One of: boolean, null |
| `inline.italic` | boolean \| null | no | One of: boolean, null |
| `inline.kerning` | number \| null | no | One of: number, null |
| `inline.lang` | object \| null | no | One of: object, null |
| `inline.letterSpacing` | number \| null | no | One of: number, null |
| `inline.ligatures` | string \| null | no | One of: string, null |
| `inline.numForm` | string \| null | no | One of: string, null |
| `inline.numSpacing` | string \| null | no | One of: string, null |
| `inline.oMath` | boolean \| null | no | One of: boolean, null |
| `inline.outline` | boolean \| null | no | One of: boolean, null |
| `inline.position` | number \| null | no | One of: number, null |
| `inline.rFonts` | object \| null | no | One of: object, null |
| `inline.rStyle` | string \| null | no | One of: string, null |
| `inline.rtl` | boolean \| null | no | One of: boolean, null |
| `inline.shading` | object \| null | no | One of: object, null |
| `inline.shadow` | boolean \| null | no | One of: boolean, null |
| `inline.smallCaps` | boolean \| null | no | One of: boolean, null |
| `inline.snapToGrid` | boolean \| null | no | One of: boolean, null |
| `inline.specVanish` | boolean \| null | no | One of: boolean, null |
| `inline.strike` | boolean \| null | no | One of: boolean, null |
| `inline.stylisticSets` | object\[] \| null | no | One of: object\[], null |
| `inline.underline` | boolean \| null \| object | no | One of: boolean, null, object |
| `inline.vanish` | boolean \| null | no | One of: boolean, null |
| `inline.vertAlign` | enum \| null | no | One of: enum, null |
| `inline.webHidden` | boolean \| null | no | One of: boolean, null |
| `target` | SelectionTarget | yes | SelectionTarget |
| `target.end` | SelectionPoint | yes | SelectionPoint |
| `target.kind` | `"selection"` | yes | Constant: `"selection"` |
| `target.start` | SelectionPoint | yes | SelectionPoint |
| `target.story` | StoryLocator | no | StoryLocator |

### Variant 2 (required: ref, inline)

| Field | Type | Required | Description |
| - | - | - | - |
| `in` | StoryLocator | no | StoryLocator |
| `inline` | object | yes | |
| `inline.bCs` | boolean \| null | no | One of: boolean, null |
| `inline.bold` | boolean \| null | no | One of: boolean, null |
| `inline.border` | object \| null | no | One of: object, null |
| `inline.caps` | boolean \| null | no | One of: boolean, null |
| `inline.charScale` | number \| null | no | One of: number, null |
| `inline.color` | string \| null | no | One of: string, null |
| `inline.contextualAlternates` | boolean \| null | no | One of: boolean, null |
| `inline.cs` | boolean \| null | no | One of: boolean, null |
| `inline.dstrike` | boolean \| null | no | One of: boolean, null |
| `inline.eastAsianLayout` | object \| null | no | One of: object, null |
| `inline.em` | string \| null | no | One of: string, null |
| `inline.emboss` | boolean \| null | no | One of: boolean, null |
| `inline.fitText` | object \| null | no | One of: object, null |
| `inline.fontFamily` | string \| null | no | One of: string, null |
| `inline.fontSize` | number \| null | no | One of: number, null |
| `inline.fontSizeCs` | number \| null | no | One of: number, null |
| `inline.highlight` | string \| null | no | One of: string, null |
| `inline.iCs` | boolean \| null | no | One of: boolean, null |
| `inline.imprint` | boolean \| null | no | One of: boolean, null |
| `inline.italic` | boolean \| null | no | One of: boolean, null |
| `inline.kerning` | number \| null | no | One of: number, null |
| `inline.lang` | object \| null | no | One of: object, null |
| `inline.letterSpacing` | number \| null | no | One of: number, null |
| `inline.ligatures` | string \| null | no | One of: string, null |
| `inline.numForm` | string \| null | no | One of: string, null |
| `inline.numSpacing` | string \| null | no | One of: string, null |
| `inline.oMath` | boolean \| null | no | One of: boolean, null |
| `inline.outline` | boolean \| null | no | One of: boolean, null |
| `inline.position` | number \| null | no | One of: number, null |
| `inline.rFonts` | object \| null | no | One of: object, null |
| `inline.rStyle` | string \| null | no | One of: string, null |
| `inline.rtl` | boolean \| null | no | One of: boolean, null |
| `inline.shading` | object \| null | no | One of: object, null |
| `inline.shadow` | boolean \| null | no | One of: boolean, null |
| `inline.smallCaps` | boolean \| null | no | One of: boolean, null |
| `inline.snapToGrid` | boolean \| null | no | One of: boolean, null |
| `inline.specVanish` | boolean \| null | no | One of: boolean, null |
| `inline.strike` | boolean \| null | no | One of: boolean, null |
| `inline.stylisticSets` | object\[] \| null | no | One of: object\[], null |
| `inline.underline` | boolean \| null \| object | no | One of: boolean, null, object |
| `inline.vanish` | boolean \| null | no | One of: boolean, null |
| `inline.vertAlign` | enum \| null | no | One of: enum, null |
| `inline.webHidden` | boolean \| null | no | One of: boolean, null |
| `ref` | string | yes | |

### Example request

```json theme={null}
{
  "in": {
    "kind": "story",
    "storyType": "body"
  },
  "inline": {
    "bold": true,
    "italic": true
  },
  "target": {
    "end": {
      "blockId": "block-abc123",
      "kind": "text",
      "offset": 0,
      "story": {
        "kind": "story",
        "storyType": "body"
      }
    },
    "kind": "selection",
    "start": {
      "blockId": "block-abc123",
      "kind": "text",
      "offset": 0,
      "story": {
        "kind": "story",
        "storyType": "body"
      }
    },
    "story": {
      "kind": "story",
      "storyType": "body"
    }
  }
}
```

## Output fields

### Variant 1 (success=true)

| Field | Type | Required | Description |
| - | - | - | - |
| `inserted` | EntityAddress\[] | no | |
| `removed` | EntityAddress\[] | no | |
| `resolution` | TextMutationResolution | yes | TextMutationResolution |
| `resolution.range` | TextMutationRange | yes | TextMutationRange |
| `resolution.range.from` | integer | yes | |
| `resolution.range.to` | integer | yes | |
| `resolution.requestedTarget` | TextAddress | no | TextAddress |
| `resolution.requestedTarget.blockId` | string | no | |
| `resolution.requestedTarget.kind` | `"text"` | no | Constant: `"text"` |
| `resolution.requestedTarget.range` | Range | no | Range |
| `resolution.requestedTarget.range.end` | integer | no | |
| `resolution.requestedTarget.range.start` | integer | no | |
| `resolution.requestedTarget.story` | StoryLocator | no | StoryLocator |
| `resolution.selectionTarget` | SelectionTarget | no | SelectionTarget |
| `resolution.selectionTarget.end` | SelectionPoint | no | SelectionPoint |
| `resolution.selectionTarget.kind` | `"selection"` | no | Constant: `"selection"` |
| `resolution.selectionTarget.start` | SelectionPoint | no | SelectionPoint |
| `resolution.selectionTarget.story` | StoryLocator | no | StoryLocator |
| `resolution.target` | TextAddress | yes | TextAddress |
| `resolution.target.blockId` | string | yes | |
| `resolution.target.kind` | `"text"` | yes | Constant: `"text"` |
| `resolution.target.range` | Range | yes | Range |
| `resolution.target.range.end` | integer | yes | |
| `resolution.target.range.start` | integer | yes | |
| `resolution.target.story` | StoryLocator | no | StoryLocator |
| `resolution.text` | string | yes | |
| `success` | `true` | yes | Constant: `true` |
| `updated` | EntityAddress\[] | no | |

### Variant 2 (success=false)

| Field | Type | Required | Description |
| - | - | - | - |
| `failure` | object | yes | |
| `failure.code` | enum | yes | `"INVALID_TARGET"`, `"NO_OP"` |
| `failure.details` | any | no | |
| `failure.message` | string | yes | |
| `resolution` | TextMutationResolution | yes | TextMutationResolution |
| `resolution.range` | TextMutationRange | yes | TextMutationRange |
| `resolution.range.from` | integer | yes | |
| `resolution.range.to` | integer | yes | |
| `resolution.requestedTarget` | TextAddress | no | TextAddress |
| `resolution.requestedTarget.blockId` | string | no | |
| `resolution.requestedTarget.kind` | `"text"` | no | Constant: `"text"` |
| `resolution.requestedTarget.range` | Range | no | Range |
| `resolution.requestedTarget.range.end` | integer | no | |
| `resolution.requestedTarget.range.start` | integer | no | |
| `resolution.requestedTarget.story` | StoryLocator | no | StoryLocator |
| `resolution.selectionTarget` | SelectionTarget | no | SelectionTarget |
| `resolution.selectionTarget.end` | SelectionPoint | no | SelectionPoint |
| `resolution.selectionTarget.kind` | `"selection"` | no | Constant: `"selection"` |
| `resolution.selectionTarget.start` | SelectionPoint | no | SelectionPoint |
| `resolution.selectionTarget.story` | StoryLocator | no | StoryLocator |
| `resolution.target` | TextAddress | yes | TextAddress |
| `resolution.target.blockId` | string | yes | |
| `resolution.target.kind` | `"text"` | yes | Constant: `"text"` |
| `resolution.target.range` | Range | yes | Range |
| `resolution.target.range.end` | integer | yes | |
| `resolution.target.range.start` | integer | yes | |
| `resolution.target.story` | StoryLocator | no | StoryLocator |
| `resolution.text` | string | yes | |
| `success` | `false` | yes | Constant: `false` |

### Example response

```json theme={null}
{
  "inserted": [
    {
      "entityId": "entity-789",
      "entityType": "comment",
      "kind": "entity"
    }
  ],
  "resolution": {
    "range": {
      "from": 0,
      "to": 10
    },
    "requestedTarget": {
      "blockId": "block-abc123",
      "kind": "text",
      "range": {
        "end": 10,
        "start": 0
      },
      "story": {
        "kind": "story",
        "storyType": "body"
      }
    },
    "selectionTarget": {
      "end": {
        "blockId": "block-abc123",
        "kind": "text",
        "offset": 0,
        "story": {
          "kind": "story",
          "storyType": "body"
        }
      },
      "kind": "selection",
      "start": {
        "blockId": "block-abc123",
        "kind": "text",
        "offset": 0,
        "story": {
          "kind": "story",
          "storyType": "body"
        }
      },
      "story": {
        "kind": "story",
        "storyType": "body"
      }
    },
    "target": {
      "blockId": "block-abc123",
      "kind": "text",
      "range": {
        "end": 10,
        "start": 0
      },
      "story": {
        "kind": "story",
        "storyType": "body"
      }
    },
    "text": "Hello, world."
  },
  "success": true,
  "updated": [
    {
      "entityId": "entity-789",
      "entityType": "comment",
      "kind": "entity"
    }
  ]
}
```

## Pre-apply throws

* `TARGET_NOT_FOUND`
* `CAPABILITY_UNAVAILABLE`
* `INVALID_TARGET`
* `INVALID_INPUT`
* `STORY_NOT_FOUND`
* `STORY_MISMATCH`
* `STORY_NOT_SUPPORTED`
* `CROSS_STORY_PLAN`
* `MATERIALIZATION_FAILED`

## Non-applied failure codes

* `INVALID_TARGET`
* `NO_OP`

## Raw schemas

> [accordion] Raw input schema
>
> ```json theme={null}
> {
>   "oneOf": [
>     {
>       "additionalProperties": false,
>       "properties": {
>         "in": {
>           "$ref": "#/$defs/StoryLocator"
>         },
>         "inline": {
>           "additionalProperties": false,
>           "description": "Inline formatting properties to apply. Set a property to apply it, use null to clear it. Example: {bold: true, italic: true} or {bold: null} to remove bold.",
>           "minProperties": 1,
>           "properties": {
>             "bCs": {
>               "oneOf": [
>                 {
>                   "type": "boolean"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "bold": {
>               "oneOf": [
>                 {
>                   "type": "boolean"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "border": {
>               "oneOf": [
>                 {
>                   "additionalProperties": false,
>                   "minProperties": 1,
>                   "properties": {
>                     "color": {
>                       "oneOf": [
>                         {
>                           "minLength": 1,
>                           "type": "string"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     },
>                     "space": {
>                       "oneOf": [
>                         {
>                           "type": "number"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     },
>                     "sz": {
>                       "oneOf": [
>                         {
>                           "type": "number"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     },
>                     "val": {
>                       "oneOf": [
>                         {
>                           "minLength": 1,
>                           "type": "string"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     }
>                   },
>                   "type": "object"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "caps": {
>               "oneOf": [
>                 {
>                   "type": "boolean"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "charScale": {
>               "oneOf": [
>                 {
>                   "type": "number"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "color": {
>               "oneOf": [
>                 {
>                   "minLength": 1,
>                   "type": "string"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "contextualAlternates": {
>               "oneOf": [
>                 {
>                   "type": "boolean"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "cs": {
>               "oneOf": [
>                 {
>                   "type": "boolean"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "dstrike": {
>               "oneOf": [
>                 {
>                   "type": "boolean"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "eastAsianLayout": {
>               "oneOf": [
>                 {
>                   "additionalProperties": false,
>                   "minProperties": 1,
>                   "properties": {
>                     "combine": {
>                       "oneOf": [
>                         {
>                           "type": "boolean"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     },
>                     "combineBrackets": {
>                       "oneOf": [
>                         {
>                           "minLength": 1,
>                           "type": "string"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     },
>                     "id": {
>                       "oneOf": [
>                         {
>                           "minLength": 1,
>                           "type": "string"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     },
>                     "vert": {
>                       "oneOf": [
>                         {
>                           "type": "boolean"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     },
>                     "vertCompress": {
>                       "oneOf": [
>                         {
>                           "type": "boolean"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     }
>                   },
>                   "type": "object"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "em": {
>               "oneOf": [
>                 {
>                   "minLength": 1,
>                   "type": "string"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "emboss": {
>               "oneOf": [
>                 {
>                   "type": "boolean"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "fitText": {
>               "oneOf": [
>                 {
>                   "additionalProperties": false,
>                   "minProperties": 1,
>                   "properties": {
>                     "id": {
>                       "oneOf": [
>                         {
>                           "minLength": 1,
>                           "type": "string"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     },
>                     "val": {
>                       "oneOf": [
>                         {
>                           "type": "number"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     }
>                   },
>                   "type": "object"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "fontFamily": {
>               "oneOf": [
>                 {
>                   "minLength": 1,
>                   "type": "string"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "fontSize": {
>               "oneOf": [
>                 {
>                   "type": "number"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "fontSizeCs": {
>               "oneOf": [
>                 {
>                   "type": "number"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "highlight": {
>               "oneOf": [
>                 {
>                   "minLength": 1,
>                   "type": "string"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "iCs": {
>               "oneOf": [
>                 {
>                   "type": "boolean"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "imprint": {
>               "oneOf": [
>                 {
>                   "type": "boolean"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "italic": {
>               "oneOf": [
>                 {
>                   "type": "boolean"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "kerning": {
>               "oneOf": [
>                 {
>                   "type": "number"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "lang": {
>               "oneOf": [
>                 {
>                   "additionalProperties": false,
>                   "minProperties": 1,
>                   "properties": {
>                     "bidi": {
>                       "oneOf": [
>                         {
>                           "minLength": 1,
>                           "type": "string"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     },
>                     "eastAsia": {
>                       "oneOf": [
>                         {
>                           "minLength": 1,
>                           "type": "string"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     },
>                     "val": {
>                       "oneOf": [
>                         {
>                           "minLength": 1,
>                           "type": "string"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     }
>                   },
>                   "type": "object"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "letterSpacing": {
>               "oneOf": [
>                 {
>                   "type": "number"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "ligatures": {
>               "oneOf": [
>                 {
>                   "minLength": 1,
>                   "type": "string"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "numForm": {
>               "oneOf": [
>                 {
>                   "minLength": 1,
>                   "type": "string"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "numSpacing": {
>               "oneOf": [
>                 {
>                   "minLength": 1,
>                   "type": "string"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "oMath": {
>               "oneOf": [
>                 {
>                   "type": "boolean"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "outline": {
>               "oneOf": [
>                 {
>                   "type": "boolean"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "position": {
>               "oneOf": [
>                 {
>                   "type": "number"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "rFonts": {
>               "oneOf": [
>                 {
>                   "additionalProperties": false,
>                   "minProperties": 1,
>                   "properties": {
>                     "ascii": {
>                       "oneOf": [
>                         {
>                           "minLength": 1,
>                           "type": "string"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     },
>                     "asciiTheme": {
>                       "oneOf": [
>                         {
>                           "minLength": 1,
>                           "type": "string"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     },
>                     "cs": {
>                       "oneOf": [
>                         {
>                           "minLength": 1,
>                           "type": "string"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     },
>                     "csTheme": {
>                       "oneOf": [
>                         {
>                           "minLength": 1,
>                           "type": "string"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     },
>                     "eastAsia": {
>                       "oneOf": [
>                         {
>                           "minLength": 1,
>                           "type": "string"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     },
>                     "eastAsiaTheme": {
>                       "oneOf": [
>                         {
>                           "minLength": 1,
>                           "type": "string"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     },
>                     "hAnsi": {
>                       "oneOf": [
>                         {
>                           "minLength": 1,
>                           "type": "string"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     },
>                     "hAnsiTheme": {
>                       "oneOf": [
>                         {
>                           "minLength": 1,
>                           "type": "string"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     },
>                     "hint": {
>                       "oneOf": [
>                         {
>                           "minLength": 1,
>                           "type": "string"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     }
>                   },
>                   "type": "object"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "rStyle": {
>               "oneOf": [
>                 {
>                   "minLength": 1,
>                   "type": "string"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "rtl": {
>               "oneOf": [
>                 {
>                   "type": "boolean"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "shading": {
>               "oneOf": [
>                 {
>                   "additionalProperties": false,
>                   "minProperties": 1,
>                   "properties": {
>                     "color": {
>                       "oneOf": [
>                         {
>                           "minLength": 1,
>                           "type": "string"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     },
>                     "fill": {
>                       "oneOf": [
>                         {
>                           "minLength": 1,
>                           "type": "string"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     },
>                     "val": {
>                       "oneOf": [
>                         {
>                           "minLength": 1,
>                           "type": "string"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     }
>                   },
>                   "type": "object"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "shadow": {
>               "oneOf": [
>                 {
>                   "type": "boolean"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "smallCaps": {
>               "oneOf": [
>                 {
>                   "type": "boolean"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "snapToGrid": {
>               "oneOf": [
>                 {
>                   "type": "boolean"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "specVanish": {
>               "oneOf": [
>                 {
>                   "type": "boolean"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "strike": {
>               "oneOf": [
>                 {
>                   "type": "boolean"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "stylisticSets": {
>               "oneOf": [
>                 {
>                   "items": {
>                     "additionalProperties": false,
>                     "properties": {
>                       "id": {
>                         "type": "number"
>                       },
>                       "val": {
>                         "type": "boolean"
>                       }
>                     },
>                     "required": [
>                       "id"
>                     ],
>                     "type": "object"
>                   },
>                   "minItems": 1,
>                   "type": "array"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "underline": {
>               "oneOf": [
>                 {
>                   "type": "boolean"
>                 },
>                 {
>                   "type": "null"
>                 },
>                 {
>                   "additionalProperties": false,
>                   "minProperties": 1,
>                   "properties": {
>                     "color": {
>                       "oneOf": [
>                         {
>                           "minLength": 1,
>                           "type": "string"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     },
>                     "style": {
>                       "oneOf": [
>                         {
>                           "minLength": 1,
>                           "type": "string"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     },
>                     "themeColor": {
>                       "oneOf": [
>                         {
>                           "minLength": 1,
>                           "type": "string"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     }
>                   },
>                   "type": "object"
>                 }
>               ]
>             },
>             "vanish": {
>               "oneOf": [
>                 {
>                   "type": "boolean"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "vertAlign": {
>               "oneOf": [
>                 {
>                   "enum": [
>                     "superscript",
>                     "subscript",
>                     "baseline"
>                   ]
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "webHidden": {
>               "oneOf": [
>                 {
>                   "type": "boolean"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             }
>           },
>           "type": "object"
>         },
>         "target": {
>           "$ref": "#/$defs/SelectionTarget",
>           "description": "Selection target: {kind:'selection', start:{kind:'text', blockId, offset}, end:{kind:'text', blockId, offset}}. Use 'ref' instead when you have a search result handle."
>         }
>       },
>       "required": [
>         "target",
>         "inline"
>       ],
>       "type": "object"
>     },
>     {
>       "additionalProperties": false,
>       "properties": {
>         "in": {
>           "$ref": "#/$defs/StoryLocator"
>         },
>         "inline": {
>           "additionalProperties": false,
>           "description": "Inline formatting properties to apply. Set a property to apply it, use null to clear it. Example: {bold: true, italic: true} or {bold: null} to remove bold.",
>           "minProperties": 1,
>           "properties": {
>             "bCs": {
>               "oneOf": [
>                 {
>                   "type": "boolean"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "bold": {
>               "oneOf": [
>                 {
>                   "type": "boolean"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "border": {
>               "oneOf": [
>                 {
>                   "additionalProperties": false,
>                   "minProperties": 1,
>                   "properties": {
>                     "color": {
>                       "oneOf": [
>                         {
>                           "minLength": 1,
>                           "type": "string"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     },
>                     "space": {
>                       "oneOf": [
>                         {
>                           "type": "number"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     },
>                     "sz": {
>                       "oneOf": [
>                         {
>                           "type": "number"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     },
>                     "val": {
>                       "oneOf": [
>                         {
>                           "minLength": 1,
>                           "type": "string"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     }
>                   },
>                   "type": "object"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "caps": {
>               "oneOf": [
>                 {
>                   "type": "boolean"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "charScale": {
>               "oneOf": [
>                 {
>                   "type": "number"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "color": {
>               "oneOf": [
>                 {
>                   "minLength": 1,
>                   "type": "string"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "contextualAlternates": {
>               "oneOf": [
>                 {
>                   "type": "boolean"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "cs": {
>               "oneOf": [
>                 {
>                   "type": "boolean"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "dstrike": {
>               "oneOf": [
>                 {
>                   "type": "boolean"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "eastAsianLayout": {
>               "oneOf": [
>                 {
>                   "additionalProperties": false,
>                   "minProperties": 1,
>                   "properties": {
>                     "combine": {
>                       "oneOf": [
>                         {
>                           "type": "boolean"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     },
>                     "combineBrackets": {
>                       "oneOf": [
>                         {
>                           "minLength": 1,
>                           "type": "string"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     },
>                     "id": {
>                       "oneOf": [
>                         {
>                           "minLength": 1,
>                           "type": "string"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     },
>                     "vert": {
>                       "oneOf": [
>                         {
>                           "type": "boolean"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     },
>                     "vertCompress": {
>                       "oneOf": [
>                         {
>                           "type": "boolean"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     }
>                   },
>                   "type": "object"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "em": {
>               "oneOf": [
>                 {
>                   "minLength": 1,
>                   "type": "string"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "emboss": {
>               "oneOf": [
>                 {
>                   "type": "boolean"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "fitText": {
>               "oneOf": [
>                 {
>                   "additionalProperties": false,
>                   "minProperties": 1,
>                   "properties": {
>                     "id": {
>                       "oneOf": [
>                         {
>                           "minLength": 1,
>                           "type": "string"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     },
>                     "val": {
>                       "oneOf": [
>                         {
>                           "type": "number"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     }
>                   },
>                   "type": "object"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "fontFamily": {
>               "oneOf": [
>                 {
>                   "minLength": 1,
>                   "type": "string"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "fontSize": {
>               "oneOf": [
>                 {
>                   "type": "number"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "fontSizeCs": {
>               "oneOf": [
>                 {
>                   "type": "number"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "highlight": {
>               "oneOf": [
>                 {
>                   "minLength": 1,
>                   "type": "string"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "iCs": {
>               "oneOf": [
>                 {
>                   "type": "boolean"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "imprint": {
>               "oneOf": [
>                 {
>                   "type": "boolean"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "italic": {
>               "oneOf": [
>                 {
>                   "type": "boolean"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "kerning": {
>               "oneOf": [
>                 {
>                   "type": "number"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "lang": {
>               "oneOf": [
>                 {
>                   "additionalProperties": false,
>                   "minProperties": 1,
>                   "properties": {
>                     "bidi": {
>                       "oneOf": [
>                         {
>                           "minLength": 1,
>                           "type": "string"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     },
>                     "eastAsia": {
>                       "oneOf": [
>                         {
>                           "minLength": 1,
>                           "type": "string"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     },
>                     "val": {
>                       "oneOf": [
>                         {
>                           "minLength": 1,
>                           "type": "string"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     }
>                   },
>                   "type": "object"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "letterSpacing": {
>               "oneOf": [
>                 {
>                   "type": "number"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "ligatures": {
>               "oneOf": [
>                 {
>                   "minLength": 1,
>                   "type": "string"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "numForm": {
>               "oneOf": [
>                 {
>                   "minLength": 1,
>                   "type": "string"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "numSpacing": {
>               "oneOf": [
>                 {
>                   "minLength": 1,
>                   "type": "string"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "oMath": {
>               "oneOf": [
>                 {
>                   "type": "boolean"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "outline": {
>               "oneOf": [
>                 {
>                   "type": "boolean"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "position": {
>               "oneOf": [
>                 {
>                   "type": "number"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "rFonts": {
>               "oneOf": [
>                 {
>                   "additionalProperties": false,
>                   "minProperties": 1,
>                   "properties": {
>                     "ascii": {
>                       "oneOf": [
>                         {
>                           "minLength": 1,
>                           "type": "string"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     },
>                     "asciiTheme": {
>                       "oneOf": [
>                         {
>                           "minLength": 1,
>                           "type": "string"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     },
>                     "cs": {
>                       "oneOf": [
>                         {
>                           "minLength": 1,
>                           "type": "string"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     },
>                     "csTheme": {
>                       "oneOf": [
>                         {
>                           "minLength": 1,
>                           "type": "string"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     },
>                     "eastAsia": {
>                       "oneOf": [
>                         {
>                           "minLength": 1,
>                           "type": "string"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     },
>                     "eastAsiaTheme": {
>                       "oneOf": [
>                         {
>                           "minLength": 1,
>                           "type": "string"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     },
>                     "hAnsi": {
>                       "oneOf": [
>                         {
>                           "minLength": 1,
>                           "type": "string"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     },
>                     "hAnsiTheme": {
>                       "oneOf": [
>                         {
>                           "minLength": 1,
>                           "type": "string"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     },
>                     "hint": {
>                       "oneOf": [
>                         {
>                           "minLength": 1,
>                           "type": "string"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     }
>                   },
>                   "type": "object"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "rStyle": {
>               "oneOf": [
>                 {
>                   "minLength": 1,
>                   "type": "string"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "rtl": {
>               "oneOf": [
>                 {
>                   "type": "boolean"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "shading": {
>               "oneOf": [
>                 {
>                   "additionalProperties": false,
>                   "minProperties": 1,
>                   "properties": {
>                     "color": {
>                       "oneOf": [
>                         {
>                           "minLength": 1,
>                           "type": "string"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     },
>                     "fill": {
>                       "oneOf": [
>                         {
>                           "minLength": 1,
>                           "type": "string"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     },
>                     "val": {
>                       "oneOf": [
>                         {
>                           "minLength": 1,
>                           "type": "string"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     }
>                   },
>                   "type": "object"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "shadow": {
>               "oneOf": [
>                 {
>                   "type": "boolean"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "smallCaps": {
>               "oneOf": [
>                 {
>                   "type": "boolean"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "snapToGrid": {
>               "oneOf": [
>                 {
>                   "type": "boolean"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "specVanish": {
>               "oneOf": [
>                 {
>                   "type": "boolean"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "strike": {
>               "oneOf": [
>                 {
>                   "type": "boolean"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "stylisticSets": {
>               "oneOf": [
>                 {
>                   "items": {
>                     "additionalProperties": false,
>                     "properties": {
>                       "id": {
>                         "type": "number"
>                       },
>                       "val": {
>                         "type": "boolean"
>                       }
>                     },
>                     "required": [
>                       "id"
>                     ],
>                     "type": "object"
>                   },
>                   "minItems": 1,
>                   "type": "array"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "underline": {
>               "oneOf": [
>                 {
>                   "type": "boolean"
>                 },
>                 {
>                   "type": "null"
>                 },
>                 {
>                   "additionalProperties": false,
>                   "minProperties": 1,
>                   "properties": {
>                     "color": {
>                       "oneOf": [
>                         {
>                           "minLength": 1,
>                           "type": "string"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     },
>                     "style": {
>                       "oneOf": [
>                         {
>                           "minLength": 1,
>                           "type": "string"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     },
>                     "themeColor": {
>                       "oneOf": [
>                         {
>                           "minLength": 1,
>                           "type": "string"
>                         },
>                         {
>                           "type": "null"
>                         }
>                       ]
>                     }
>                   },
>                   "type": "object"
>                 }
>               ]
>             },
>             "vanish": {
>               "oneOf": [
>                 {
>                   "type": "boolean"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "vertAlign": {
>               "oneOf": [
>                 {
>                   "enum": [
>                     "superscript",
>                     "subscript",
>                     "baseline"
>                   ]
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             },
>             "webHidden": {
>               "oneOf": [
>                 {
>                   "type": "boolean"
>                 },
>                 {
>                   "type": "null"
>                 }
>               ]
>             }
>           },
>           "type": "object"
>         },
>         "ref": {
>           "description": "Handle ref string from a superdoc_search result. Pass the handle.ref value directly (e.g. 'text:eyJ...'). Preferred over 'target' for inline formatting.",
>           "type": "string"
>         }
>       },
>       "required": [
>         "ref",
>         "inline"
>       ],
>       "type": "object"
>     }
>   ]
> }
> ```

> [accordion] Raw output schema
>
> ```json theme={null}
> {
>   "oneOf": [
>     {
>       "$ref": "#/$defs/TextMutationSuccess"
>     },
>     {
>       "additionalProperties": false,
>       "properties": {
>         "failure": {
>           "additionalProperties": false,
>           "properties": {
>             "code": {
>               "enum": [
>                 "INVALID_TARGET",
>                 "NO_OP"
>               ]
>             },
>             "details": {},
>             "message": {
>               "type": "string"
>             }
>           },
>           "required": [
>             "code",
>             "message"
>           ],
>           "type": "object"
>         },
>         "resolution": {
>           "$ref": "#/$defs/TextMutationResolution"
>         },
>         "success": {
>           "const": false
>         }
>       },
>       "required": [
>         "success",
>         "failure",
>         "resolution"
>       ],
>       "type": "object"
>     }
>   ]
> }
> ```

> [accordion] Raw success schema
>
> ```json theme={null}
> {
>   "$ref": "#/$defs/TextMutationSuccess"
> }
> ```

> [accordion] Raw failure schema
>
> ```json theme={null}
> {
>   "additionalProperties": false,
>   "properties": {
>     "failure": {
>       "additionalProperties": false,
>       "properties": {
>         "code": {
>           "enum": [
>             "INVALID_TARGET",
>             "NO_OP"
>           ]
>         },
>         "details": {},
>         "message": {
>           "type": "string"
>         }
>       },
>       "required": [
>         "code",
>         "message"
>       ],
>       "type": "object"
>     },
>     "resolution": {
>       "$ref": "#/$defs/TextMutationResolution"
>     },
>     "success": {
>       "const": false
>     }
>   },
>   "required": [
>     "success",
>     "failure",
>     "resolution"
>   ],
>   "type": "object"
> }
> ```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.