Summary
Set or clear therFonts inline run property on the target text range.
- Operation ID:
format.rFonts - API member path:
editor.doc.format.rFonts(...) - Mutates document:
yes - Idempotency:
conditional - Supports tracked mode:
no - Supports dry run:
yes - Deterministic target resolution:
yes
Expected result
Returns a TextMutationReceipt confirming the inline run property patch was applied to the target range.Input fields
Variant 1 (target.kind=“selection”)
| Field | Type | Required | Description |
|---|---|---|---|
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 |
value | object | null | yes | One of: object, null |
Variant 2 (required: ref, value)
| Field | Type | Required | Description |
|---|---|---|---|
ref | string | yes | |
value | object | null | yes | One of: object, null |
Example request
{
"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"
}
},
"value": {
"ascii": "example",
"hAnsi": "example"
}
}
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" |
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
{
"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_FOUNDCAPABILITY_UNAVAILABLEINVALID_TARGETINVALID_INPUTSTORY_NOT_FOUNDSTORY_MISMATCHSTORY_NOT_SUPPORTEDCROSS_STORY_PLANMATERIALIZATION_FAILED
Non-applied failure codes
INVALID_TARGET
Raw schemas
Raw input schema
Raw input schema
{
"oneOf": [
{
"additionalProperties": false,
"properties": {
"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."
},
"value": {
"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"
}
]
}
},
"required": [
"target",
"value"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"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"
},
"value": {
"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"
}
]
}
},
"required": [
"ref",
"value"
],
"type": "object"
}
]
}
Raw output schema
Raw output schema
{
"oneOf": [
{
"$ref": "#/$defs/TextMutationSuccess"
},
{
"additionalProperties": false,
"properties": {
"failure": {
"additionalProperties": false,
"properties": {
"code": {
"enum": [
"INVALID_TARGET"
]
},
"details": {},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object"
},
"resolution": {
"$ref": "#/$defs/TextMutationResolution"
},
"success": {
"const": false
}
},
"required": [
"success",
"failure",
"resolution"
],
"type": "object"
}
]
}
Raw success schema
Raw success schema
{
"$ref": "#/$defs/TextMutationSuccess"
}
Raw failure schema
Raw failure schema
{
"additionalProperties": false,
"properties": {
"failure": {
"additionalProperties": false,
"properties": {
"code": {
"enum": [
"INVALID_TARGET"
]
},
"details": {},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object"
},
"resolution": {
"$ref": "#/$defs/TextMutationResolution"
},
"success": {
"const": false
}
},
"required": [
"success",
"failure",
"resolution"
],
"type": "object"
}