Google Docs Batch Update icon

Google Docs Batch Update

Build and send Google Docs batch update requests

Create Tables Request → Pin Table Header Rows

AI-generated

Summary

Pins a specified number of rows as header rows for a Google Docs table, making them repeat on each new page.

Inputs

  • index (required) — The zero-based index (in UTF-16 code units) of the first row to pin as a header. The index is relative to the beginning of the segment specified by segmentId.
  • pinnedHeaderRowsCount (required) — The number of rows starting at the specified index to pin as header rows.
  • additionalLocationFields — A collection of fields to specify the precise location in the document. Includes 'segmentId' (the ID of the header, footer, or footnote the location is in; empty signifies the document's body) and 'tabId' (the tab that the location is in; when omitted, the request applies to the first tab).

Output shape

A single successful item (status: 200 OK) or a single error item (status: 4xx/5xx).

The operation performs a batch update to the Google Docs API. The node executes the request for each input item, returning the API response for each item.

Examples

Example 1: Pin the first 2 rows of a table as header rows.

Set Table Start Index to 0, Pinned Header Rows Count to 2, and omit Additional Location Fields to apply to the first tab of the document body.

Example 2: Pin a specific set of header rows within a multi-tab document.

Set Table Start Index to 2, Pinned Header Rows Count to 3, and include tabId in Additional Location Fields to target a specific tab.

Links

Discussion