tables.setRowOptions

Set options on a table row such as header repeat or page break.

Summary

Set options on a table row such as header repeat or page break.

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

Expected result

Returns a TableMutationResult receipt; reports NO_OP if row options already match.

Input fields

Variant 1 (target.nodeType=“tableRow”)

Field	Type	Required	Description
allowBreakAcrossPages	boolean	no
repeatHeader	boolean	no
target	TableRowAddress	yes	TableRowAddress
target.kind	"block"	yes	Constant: "block"
target.nodeId	string	yes
target.nodeType	"tableRow"	yes	Constant: "tableRow"

Variant 2 (target.nodeType=“table”)

Field	Type	Required	Description
allowBreakAcrossPages	boolean	no
repeatHeader	boolean	no
rowIndex	integer	yes
target	TableAddress	yes	TableAddress
target.kind	"block"	yes	Constant: "block"
target.nodeId	string	yes
target.nodeType	"table"	yes	Constant: "table"

Variant 3 (required: nodeId, rowIndex)

Field	Type	Required	Description
allowBreakAcrossPages	boolean	no
nodeId	string	yes
repeatHeader	boolean	no
rowIndex	integer	yes

Example request

{
  "allowBreakAcrossPages": true,
  "repeatHeader": true,
  "target": {
    "kind": "block",
    "nodeId": "node-def456",
    "nodeType": "tableRow"
  }
}

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

Non-applied failure codes

• INVALID_TARGET
• NO_OP

Raw schemas

Raw input schema

{
  "oneOf": [
    {
      "additionalProperties": false,
      "properties": {
        "allowBreakAcrossPages": {
          "type": "boolean"
        },
        "repeatHeader": {
          "type": "boolean"
        },
        "target": {
          "$ref": "#/$defs/TableRowAddress"
        }
      },
      "required": [
        "target"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "allowBreakAcrossPages": {
          "type": "boolean"
        },
        "repeatHeader": {
          "type": "boolean"
        },
        "rowIndex": {
          "minimum": 0,
          "type": "integer"
        },
        "target": {
          "$ref": "#/$defs/TableAddress"
        }
      },
      "required": [
        "target",
        "rowIndex"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "allowBreakAcrossPages": {
          "type": "boolean"
        },
        "nodeId": {
          "type": "string"
        },
        "repeatHeader": {
          "type": "boolean"
        },
        "rowIndex": {
          "minimum": 0,
          "type": "integer"
        }
      },
      "required": [
        "nodeId",
        "rowIndex"
      ],
      "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"
}