lists.applyStyle

Apply a reusable list style to the target list. Sequence-local: if the abstract definition is shared with other lists, it is cloned first to avoid affecting them.

Summary

Apply a reusable list style to the target list. Sequence-local: if the abstract definition is shared with other lists, it is cloned first to avoid affecting them.

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

Expected result

Returns a ListsMutateItemResult receipt; reports NO_OP if all levels already match.

Input fields

Field	Type	Required	Description
levels	integer[]	no
style	object	yes
style.levels	object[]	yes
style.version	1	yes	Constant: 1
target	ListItemAddress	yes	ListItemAddress
target.kind	"block"	yes	Constant: "block"
target.nodeId	string	yes
target.nodeType	"listItem"	yes	Constant: "listItem"

Example request

{
  "levels": [
    1
  ],
  "style": {
    "levels": [
      {
        "level": 1,
        "lvlText": "example",
        "numFmt": "example"
      }
    ],
    "version": 1
  },
  "target": {
    "kind": "block",
    "nodeId": "node-def456",
    "nodeType": "listItem"
  }
}

Output fields

Variant 1 (success=true)

Field	Type	Required	Description
item	ListItemAddress	yes	ListItemAddress
item.kind	"block"	yes	Constant: "block"
item.nodeId	string	yes
item.nodeType	"listItem"	yes	Constant: "listItem"
success	true	yes	Constant: true

Variant 2 (success=false)

Field	Type	Required	Description
failure	object	yes
failure.code	enum	yes	"NO_OP", "INVALID_TARGET", "INVALID_INPUT", "LEVEL_OUT_OF_RANGE"
failure.details	any	no
failure.message	string	yes
success	false	yes	Constant: false

Example response

{
  "item": {
    "kind": "block",
    "nodeId": "node-def456",
    "nodeType": "listItem"
  },
  "success": true
}

Pre-apply throws

• TARGET_NOT_FOUND
• CAPABILITY_UNAVAILABLE
• INVALID_TARGET
• INVALID_INPUT

Non-applied failure codes

• NO_OP
• INVALID_TARGET
• INVALID_INPUT
• LEVEL_OUT_OF_RANGE

Raw schemas

Raw input schema

{
  "additionalProperties": false,
  "properties": {
    "levels": {
      "items": {
        "maximum": 8,
        "minimum": 0,
        "type": "integer"
      },
      "type": "array"
    },
    "style": {
      "additionalProperties": false,
      "properties": {
        "levels": {
          "items": {
            "additionalProperties": false,
            "properties": {
              "alignment": {
                "enum": [
                  "left",
                  "center",
                  "right"
                ]
              },
              "indents": {
                "additionalProperties": false,
                "properties": {
                  "firstLine": {
                    "type": "integer"
                  },
                  "hanging": {
                    "type": "integer"
                  },
                  "left": {
                    "type": "integer"
                  }
                },
                "type": "object"
              },
              "level": {
                "maximum": 8,
                "minimum": 0,
                "type": "integer"
              },
              "lvlText": {
                "type": "string"
              },
              "markerFont": {
                "type": "string"
              },
              "numFmt": {
                "type": "string"
              },
              "pictureBulletId": {
                "type": "integer"
              },
              "start": {
                "type": "integer"
              },
              "tabStopAt": {
                "type": [
                  "integer",
                  "null"
                ]
              },
              "trailingCharacter": {
                "enum": [
                  "tab",
                  "space",
                  "nothing"
                ]
              }
            },
            "required": [
              "level"
            ],
            "type": "object"
          },
          "type": "array"
        },
        "version": {
          "const": 1
        }
      },
      "required": [
        "version",
        "levels"
      ],
      "type": "object"
    },
    "target": {
      "$ref": "#/$defs/ListItemAddress"
    }
  },
  "required": [
    "target",
    "style"
  ],
  "type": "object"
}

Raw output schema

{
  "oneOf": [
    {
      "additionalProperties": false,
      "properties": {
        "item": {
          "$ref": "#/$defs/ListItemAddress"
        },
        "success": {
          "const": true
        }
      },
      "required": [
        "success",
        "item"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "failure": {
          "additionalProperties": false,
          "properties": {
            "code": {
              "enum": [
                "NO_OP",
                "INVALID_TARGET",
                "INVALID_INPUT",
                "LEVEL_OUT_OF_RANGE"
              ]
            },
            "details": {},
            "message": {
              "type": "string"
            }
          },
          "required": [
            "code",
            "message"
          ],
          "type": "object"
        },
        "success": {
          "const": false
        }
      },
      "required": [
        "success",
        "failure"
      ],
      "type": "object"
    }
  ]
}

Raw success schema

{
  "additionalProperties": false,
  "properties": {
    "item": {
      "$ref": "#/$defs/ListItemAddress"
    },
    "success": {
      "const": true
    }
  },
  "required": [
    "success",
    "item"
  ],
  "type": "object"
}

Raw failure schema

{
  "additionalProperties": false,
  "properties": {
    "failure": {
      "additionalProperties": false,
      "properties": {
        "code": {
          "enum": [
            "NO_OP",
            "INVALID_TARGET",
            "INVALID_INPUT",
            "LEVEL_OUT_OF_RANGE"
          ]
        },
        "details": {},
        "message": {
          "type": "string"
        }
      },
      "required": [
        "code",
        "message"
      ],
      "type": "object"
    },
    "success": {
      "const": false
    }
  },
  "required": [
    "success",
    "failure"
  ],
  "type": "object"
}