Update a list of documents

This action allows you to edit/update multiple documents in a Firestore collection at once.


Inputs and Settings

Documents IDs (list)

The list of IDs of the documents you want to update.

Collection

The name or ID of the collection the documents you want to update are stored in.

Trigger ID (optional)

This will link the action with a Action Listener of the same ID.

If left blank, all listeners on the page with blank ID's will be triggered at the same time, so we suggest to always define a Trigger ID.

When the function finishes running, it will trigger the List Operation Finished event.

Fields

You must inform which fields you want to update, in JSON format. This input allows you to set as many fields as you want.

For each field you must specify the "key" and the "value" that will be stored on it. For instance, you might want to check all tasks on our task manager sample app, by changing the "done" field to "true". You'd need to define the "key" = "done" and the "value" = "true".

Field Types

For each key/value pair you define and provide a value on the Fields list, you must provide the same key, but with the type of the value, on the Field Types input. That allows the plugin to turn the texts being fed into the plugin into corresponding values on the JSON structure sent to Firestore.

If the number of Fields and Field Types don't match, the action will result in an error.

See the field types table to see which types are currently supported by the plugin and how to define them.


Triggered events

Those events are triggered by an Action Listener with the same ID as the Trigger ID provided on the action.

  • List Operation Finished (if the action was successful)

  • Error in Action (if an error occurs)


Stored values on the listener

Error Message

If an error occurs, you can check its details on this state on the action listener.

Last updated