Update document with the Google Docs API

Applies a list of edits to a document, in order and all or nothing: if one request is invalid, none is applied. Each item of requests has exactly one kind of edit. replaceAllText fills a template without positions; the other kinds use the indexes from Get document. Send edits with indexes from the highest index to the lowest, so one does not shift the next.

Identifier
google_docs_update_document

The request

POST https://connect.reportei.com/api/tools/google_docs_update_document/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "documentId": "<documentId>",
    "requests": []
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
documentIdstringYesDocument id: the part of the URL of the document between /d/ and /edit, or the documentId from Create document.
requestsarrayYesThe edits, applied in order. Each item has exactly one of the keys below. Other kinds of the Docs API reference, such as insertTableRow or createHeader, are accepted too.
writeControlobjectNoGuards the edits against changes made to the document after Get document. Use one of the two fields.

Supported connections

Your customer connects their Google Docs account once, with one of the modes below. The same connection serves every tool of the toolkit.

OAuth with your product's app

You register your product's OAuth app once, with POST /api/merchants/credentials/google_docs, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/google_docs_update_document. It becomes your agent's tool definition with no conversion.

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.