tables.mergeCells

Summary

Merge a range of table cells into one.

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

Expected result

Returns a TableMutationResult receipt; reports NO_OP if the cells are already merged.

Input fields

Variant 1 (target.nodeType=“table”)

Field	Type	Required	Description
`end`	object	yes
`end.columnIndex`	integer	yes
`end.rowIndex`	integer	yes
`start`	object	yes
`start.columnIndex`	integer	yes
`start.rowIndex`	integer	yes
`target`	TableAddress	yes	TableAddress
`target.kind`	`"block"`	yes	Constant: `"block"`
`target.nodeId`	string	yes
`target.nodeType`	`"table"`	yes	Constant: `"table"`

Variant 2 (required: nodeId)

Field	Type	Required
`end`	object	yes
`end.columnIndex`	integer	yes
`end.rowIndex`	integer	yes
`nodeId`	string	yes
`start`	object	yes
`start.columnIndex`	integer	yes
`start.rowIndex`	integer	yes

Example request

{
  "end": {
    "columnIndex": 1,
    "rowIndex": 1
  },
  "start": {
    "columnIndex": 1,
    "rowIndex": 1
  },
  "target": {
    "kind": "block",
    "nodeId": "node-def456",
    "nodeType": "table"
  }
}

Output fields

Variant 1 (success=true)

Field	Type	Required	Description
`success`	`true`	yes	Constant: `true`
`table`	TableAddress	no	TableAddress
`table.kind`	`"block"`	no	Constant: `"block"`
`table.nodeId`	string	no
`table.nodeType`	`"table"`	no	Constant: `"table"`
`trackedChangeRefs`	EntityAddress[]	no

Variant 2 (success=false)

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

When present, result.table is the follow-up address to reuse after this call. For non-destructive table-targeted mutations, pass result.table.nodeId to the next table operation instead of re-running find(). Destructive operations may omit table.

Example response

{
  "success": true,
  "table": {
    "kind": "block",
    "nodeId": "node-def456",
    "nodeType": "table"
  },
  "trackedChangeRefs": [
    {
      "entityId": "entity-789",
      "entityType": "comment",
      "kind": "entity"
    }
  ]
}

Pre-apply throws

TARGET_NOT_FOUND
INVALID_TARGET
CAPABILITY_UNAVAILABLE
INVALID_CONTEXT

Non-applied failure codes

INVALID_TARGET
NO_OP
INVALID_CONTEXT

Raw schemas

Raw input schema

{
  "additionalProperties": false,
  "oneOf": [
    {
      "required": [
        "target"
      ]
    },
    {
      "required": [
        "nodeId"
      ]
    }
  ],
  "properties": {
    "end": {
      "additionalProperties": false,
      "properties": {
        "columnIndex": {
          "minimum": 0,
          "type": "integer"
        },
        "rowIndex": {
          "minimum": 0,
          "type": "integer"
        }
      },
      "required": [
        "rowIndex",
        "columnIndex"
      ],
      "type": "object"
    },
    "nodeId": {
      "type": "string"
    },
    "start": {
      "additionalProperties": false,
      "properties": {
        "columnIndex": {
          "minimum": 0,
          "type": "integer"
        },
        "rowIndex": {
          "minimum": 0,
          "type": "integer"
        }
      },
      "required": [
        "rowIndex",
        "columnIndex"
      ],
      "type": "object"
    },
    "target": {
      "$ref": "#/$defs/TableAddress"
    }
  },
  "required": [
    "start",
    "end"
  ],
  "type": "object"
}

Raw output schema

{
  "oneOf": [
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "const": true
        },
        "table": {
          "$ref": "#/$defs/TableAddress"
        },
        "trackedChangeRefs": {
          "items": {
            "$ref": "#/$defs/EntityAddress"
          },
          "type": "array"
        }
      },
      "required": [
        "success"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "failure": {
          "additionalProperties": false,
          "properties": {
            "code": {
              "enum": [
                "NO_OP",
                "INVALID_TARGET",
                "TARGET_NOT_FOUND",
                "CAPABILITY_UNAVAILABLE"
              ]
            },
            "details": {},
            "message": {
              "type": "string"
            }
          },
          "required": [
            "code",
            "message"
          ],
          "type": "object"
        },
        "success": {
          "const": false
        }
      },
      "required": [
        "success",
        "failure"
      ],
      "type": "object"
    }
  ]
}

Raw success schema

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "const": true
    },
    "table": {
      "$ref": "#/$defs/TableAddress"
    },
    "trackedChangeRefs": {
      "items": {
        "$ref": "#/$defs/EntityAddress"
      },
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "type": "object"
}

Raw failure schema

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

Getting Started

Editor

Document Engine

AI

Solutions

Resources

tables.mergeCells

Summary

Expected result

Input fields

Variant 1 (target.nodeType=“table”)

Variant 2 (required: nodeId)

Example request

Output fields

Variant 1 (success=true)

Variant 2 (success=false)

Example response

Pre-apply throws

Non-applied failure codes

Raw schemas

​Summary

​Expected result

​Input fields

​Variant 1 (target.nodeType=“table”)

​Variant 2 (required: nodeId)

​Example request

​Output fields

​Variant 1 (success=true)

​Variant 2 (success=false)

​Example response

​Pre-apply throws

​Non-applied failure codes

​Raw schemas

Summary

Expected result

Input fields

Variant 1 (target.nodeType=“table”)

Variant 2 (required: nodeId)

Example request

Output fields

Variant 1 (success=true)

Variant 2 (success=false)

Example response

Pre-apply throws

Non-applied failure codes

Raw schemas