Document apiReferenceTables

tables.insertRow

Insert a new row into the target table. The new row is cloned from an adjacent row, so it inherits the existing cell shading, borders, alignment, and padding. No follow-up styling call is needed unless the new row should look different from the rest of the table.

mutates documenttracked modedry runnon-idempotent
doc.tables.insertRow(…)

Expected result

Returns a TableMutationResult receipt confirming a row was inserted.

Inputs

Variant 1
targetTableRowAddressrequired
Fields
kind"block"required
nodeType"tableRow"required
nodeIdstringrequired
position"above" | "below"required
countinteger
Variant 2
targetTableAddressrequired
Fields
kind"block"required
nodeType"table"required
nodeIdstringrequired
rowIndexintegerrequired
position"above" | "below"required
countinteger
Variant 3
nodeIdstringrequired
rowIndexintegerrequired
position"above" | "below"required
countinteger
Variant 4
targetTableAddressconditionally required
Fields
kind"block"required
nodeType"table"required
nodeIdstringrequired
nodeIdstringconditionally required
countinteger

Result

Output fields
true
successtruerequired
tableTableAddress
Fields
kind"block"required
nodeType"table"required
nodeIdstringrequired
trackedChangeRefsEntityAddress[]
false
successfalserequired
failureobjectrequired
Fields
code"NO_OP" | "INVALID_TARGET" | "TARGET_NOT_FOUND" | "CAPABILITY_UNAVAILABLE"required
messagestringrequired
detailsunknown

Failures

Pre-apply throws

  • TARGET_NOT_FOUND
  • INVALID_TARGET
  • CAPABILITY_UNAVAILABLE
1 more codes
  • INVALID_TARGET

Non-applied receipt codes

  • INVALID_TARGET

Raw schemas

Open the generated JSON artifact for the exact input, output, success, and failure schemas represented by this contract version.

View raw JSON schemas