Update Document
firestore.update_document
ActionDatabases & warehousesconnection required
Calls the Firestore API PATCH documents/{path}?updateMask.fieldPaths=...
Merge fields into an existing Firestore document (other fields are kept).
Connection
- Required
- Yes — the node will not save without one
- Auth type
- OAuth 2.0
- Providers
- Google Firestore
- Secret shape
- {"client_id", "client_secret", "refresh_token"}
- Config it needs
- project_id
- Resolved by
- config.connection_id, else node.connection_id
Configuration
4 fields, 3 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
project_id GCP project id (overrides connection). | string | No | — | — | — |
collection Collection id. | string | Yes | — | — | — |
document_id Id of the document to act on, from firestore.list_documents — not its name. | string | Yes | — | — | — |
fields Fields to merge; only these are written, the rest of the document is kept. At least one is required. | object | Yes | — | ≥ 1 characters | {"status":"sent"} |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"fields": {
"status": "sent"
}
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
ok | boolean | — |
document_id | string | — |
fields | object | — |
updated | array | — |
{
"document_id": "",
"fields": {},
"ok": false,
"updated": []
}See Update Document run in a workflow.
In a technical demo we add the Google Firestore connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.