lists.setType

Convert a list to ordered or bullet and merge adjacent compatible sequences to preserve continuous numbering.

Alpha: Document API is currently alpha and subject to breaking changes.

Summary

Convert a list to ordered or bullet and merge adjacent compatible sequences to preserve continuous numbering.

• Operation ID: lists.setType
• API member path: editor.doc.lists.setType(...)
• 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 the list is already the requested kind and no sequences were merged.

Input fields

Field	Type	Required	Description
continuity	enum	no	"preserve", "none"
kind	enum	yes	"ordered", "bullet"
target	ListItemAddress	yes	ListItemAddress
target.kind	"block"	yes	Constant: "block"
target.nodeId	string	yes
target.nodeType	"listItem"	yes	Constant: "listItem"

Example request

{
  "continuity": "preserve",
  "kind": "ordered",
  "target": {
    "kind": "block",
    "nodeId": "node-def456",
    "nodeType": "listItem"
  }
}

Output fields

Variant 1 (item.kind=“block”)

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"
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

Raw schemas

Raw input schema

{
  "additionalProperties": false,
  "properties": {
    "continuity": {
      "enum": [
        "preserve",
        "none"
      ]
    },
    "kind": {
      "enum": [
        "ordered",
        "bullet"
      ]
    },
    "target": {
      "$ref": "#/$defs/ListItemAddress"
    }
  },
  "required": [
    "target",
    "kind"
  ],
  "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"
              ]
            },
            "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"
          ]
        },
        "details": {},
        "message": {
          "type": "string"
        }
      },
      "required": [
        "code",
        "message"
      ],
      "type": "object"
    },
    "success": {
      "const": false
    }
  },
  "required": [
    "success",
    "failure"
  ],
  "type": "object"
}