lists.create

Create a new list from one or more paragraphs, or convert existing paragraphs into a new list.

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

Summary

Create a new list from one or more paragraphs, or convert existing paragraphs into a new list.

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

Expected result

Returns a ListsCreateResult with the new listId and the first item address.

Input fields

Field	Type	Required	Description
at	BlockAddress	no	BlockAddress
at.kind	"block"	no	Constant: "block"
at.nodeId	string	no
at.nodeType	"paragraph"	no	Constant: "paragraph"
kind	enum	yes	"ordered", "bullet"
level	integer	no
mode	enum	yes	"empty", "fromParagraphs"
target	BlockAddressOrRange	no	BlockAddressOrRange

Example request

{
  "at": {
    "kind": "block",
    "nodeId": "node-def456",
    "nodeType": "paragraph"
  },
  "kind": "ordered",
  "mode": "empty",
  "target": {
    "kind": "block",
    "nodeId": "node-def456",
    "nodeType": "paragraph"
  }
}

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"
listId	string	yes
success	true	yes	Constant: true

Variant 2 (success=false)

Field	Type	Required	Description
failure	object	yes
failure.code	enum	yes	"INVALID_TARGET", "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"
  },
  "listId": "example",
  "success": true
}

Pre-apply throws

• TARGET_NOT_FOUND
• CAPABILITY_UNAVAILABLE
• INVALID_TARGET

Non-applied failure codes

• INVALID_TARGET
• LEVEL_OUT_OF_RANGE

Raw schemas

Raw input schema

{
  "additionalProperties": false,
  "else": {
    "required": [
      "mode",
      "kind",
      "target"
    ]
  },
  "if": {
    "properties": {
      "mode": {
        "const": "empty"
      }
    }
  },
  "properties": {
    "at": {
      "$ref": "#/$defs/BlockAddress"
    },
    "kind": {
      "enum": [
        "ordered",
        "bullet"
      ]
    },
    "level": {
      "maximum": 8,
      "minimum": 0,
      "type": "integer"
    },
    "mode": {
      "enum": [
        "empty",
        "fromParagraphs"
      ]
    },
    "target": {
      "$ref": "#/$defs/BlockAddressOrRange"
    }
  },
  "required": [
    "mode",
    "kind"
  ],
  "then": {
    "required": [
      "mode",
      "kind",
      "at"
    ]
  },
  "type": "object"
}

Raw output schema

{
  "oneOf": [
    {
      "additionalProperties": false,
      "properties": {
        "item": {
          "$ref": "#/$defs/ListItemAddress"
        },
        "listId": {
          "type": "string"
        },
        "success": {
          "const": true
        }
      },
      "required": [
        "success",
        "listId",
        "item"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "failure": {
          "additionalProperties": false,
          "properties": {
            "code": {
              "enum": [
                "INVALID_TARGET",
                "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"
    },
    "listId": {
      "type": "string"
    },
    "success": {
      "const": true
    }
  },
  "required": [
    "success",
    "listId",
    "item"
  ],
  "type": "object"
}

Raw failure schema

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