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

​
Summary

Apply a table style and/or style options in one call.
  • Operation ID: tables.applyStyle
  • API member path: editor.doc.tables.applyStyle(...)
  • 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 style and all provided options already match.

​
Input fields

​
Variant 1 (target.kind=“block”)

FieldTypeRequiredDescription
styleIdstringno
styleOptionsobjectno
styleOptions.bandedColumnsbooleanno
styleOptions.bandedRowsbooleanno
styleOptions.firstColumnbooleanno
styleOptions.headerRowbooleanno
styleOptions.lastColumnbooleanno
styleOptions.lastRowbooleanno
styleOptions.totalRowbooleanno
targetBlockNodeAddressyesBlockNodeAddress
target.kind"block"yesConstant: "block"
target.nodeIdstringyes
target.nodeTypeenumyes"paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt"

​
Variant 2 (required: nodeId)

FieldTypeRequiredDescription
nodeIdstringyes
styleIdstringno
styleOptionsobjectno
styleOptions.bandedColumnsbooleanno
styleOptions.bandedRowsbooleanno
styleOptions.firstColumnbooleanno
styleOptions.headerRowbooleanno
styleOptions.lastColumnbooleanno
styleOptions.lastRowbooleanno
styleOptions.totalRowbooleanno

​
Example request

{
  "styleId": "style-001",
  "styleOptions": {
    "headerRow": true,
    "lastRow": true
  },
  "target": {
    "kind": "block",
    "nodeId": "node-def456",
    "nodeType": "paragraph"
  }
}

​
Output fields

​
Variant 1 (success=true)

FieldTypeRequiredDescription
successtrueyesConstant: true
tableTableAddressnoTableAddress
table.kind"block"noConstant: "block"
table.nodeIdstringno
table.nodeType"table"noConstant: "table"
trackedChangeRefsEntityAddress[]no

​
Variant 2 (success=false)

FieldTypeRequiredDescription
failureobjectyes
failure.codeenumyes"NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE"
failure.detailsanyno
failure.messagestringyes
successfalseyesConstant: 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

  • NO_OP
  • INVALID_TARGET
  • INVALID_INPUT

​
Raw schemas

{
  "additionalProperties": false,
  "oneOf": [
    {
      "required": [
        "target"
      ]
    },
    {
      "required": [
        "nodeId"
      ]
    }
  ],
  "properties": {
    "nodeId": {
      "type": "string"
    },
    "styleId": {
      "type": "string"
    },
    "styleOptions": {
      "additionalProperties": false,
      "properties": {
        "bandedColumns": {
          "type": "boolean"
        },
        "bandedRows": {
          "type": "boolean"
        },
        "firstColumn": {
          "type": "boolean"
        },
        "headerRow": {
          "type": "boolean"
        },
        "lastColumn": {
          "type": "boolean"
        },
        "lastRow": {
          "type": "boolean"
        },
        "totalRow": {
          "type": "boolean"
        }
      },
      "type": "object"
    },
    "target": {
      "$ref": "#/$defs/BlockNodeAddress"
    }
  },
  "type": "object"
}

{
  "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"
    }
  ]
}

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