Skip to main content

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.

​
Summary

Delete the entire list that contains the targeted list item. Removes ALL items in the same numbered sequence (the contiguous run of list items sharing the target’s numbering) AND their text content from the document. Pass any single list item from the list as target; the op walks adjacent siblings to find the full list. Use this for “remove the list” / “delete this list” intents and for the cleanup step of a list-to-table conversion.
  • Operation ID: lists.delete
  • API member path: editor.doc.lists.delete(...)
  • Mutates document: yes
  • Idempotency: conditional
  • Supports tracked mode: no
  • Supports dry run: yes
  • Deterministic target resolution: yes

​
Expected result

Returns a ListsDeleteResult with deletedCount (number of items removed). Reports failure (INVALID_TARGET) if the target is not a list item.

​
Input fields

FieldTypeRequiredDescription
targetListItemAddressyesListItemAddress
target.kind"block"yesConstant: "block"
target.nodeIdstringyes
target.nodeType"listItem"yesConstant: "listItem"

​
Example request

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

​
Output fields

​
Variant 1 (success=true)

FieldTypeRequiredDescription
deletedCountintegeryes
successtrueyesConstant: true

​
Variant 2 (success=false)

FieldTypeRequiredDescription
failureobjectyes
failure.codeenumyes"INVALID_TARGET"
failure.detailsanyno
failure.messagestringyes
successfalseyesConstant: false

​
Example response

{
  "deletedCount": 1,
  "success": true
}

​
Pre-apply throws

  • TARGET_NOT_FOUND
  • CAPABILITY_UNAVAILABLE
  • INVALID_TARGET

​
Non-applied failure codes

  • INVALID_TARGET

​
Raw schemas

{
  "additionalProperties": false,
  "properties": {
    "target": {
      "$ref": "#/$defs/ListItemAddress"
    }
  },
  "required": [
    "target"
  ],
  "type": "object"
}

{
  "oneOf": [
    {
      "additionalProperties": false,
      "properties": {
        "deletedCount": {
          "minimum": 0,
          "type": "integer"
        },
        "success": {
          "const": true
        }
      },
      "required": [
        "success",
        "deletedCount"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "failure": {
          "additionalProperties": false,
          "properties": {
            "code": {
              "enum": [
                "INVALID_TARGET"
              ]
            },
            "details": {},
            "message": {
              "type": "string"
            }
          },
          "required": [
            "code",
            "message"
          ],
          "type": "object"
        },
        "success": {
          "const": false
        }
      },
      "required": [
        "success",
        "failure"
      ],
      "type": "object"
    }
  ]
}

{
  "additionalProperties": false,
  "properties": {
    "deletedCount": {
      "minimum": 0,
      "type": "integer"
    },
    "success": {
      "const": true
    }
  },
  "required": [
    "success",
    "deletedCount"
  ],
  "type": "object"
}

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