Bulk update records with field values | Flatfile

Updates multiple records at once with the same field values based on filter criteria. This is similar to a SQL UPDATE statement where you can update specific fields for all records matching certain conditions.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

sheetIdstringRequired

ID of sheet

Query parameters

filterenumOptional

Options to filter records

Allowed values:

filterFieldstringOptional

Name of field by which to filter records

searchValuestringOptional

Search for the given value, returning matching rows. For exact matches, wrap the value in double quotes (“Bob”). To search for null values, send empty double quotes ("")

searchFieldstringOptional

Use this to narrow the searchValue results to a specific field

sortFieldstringOptional

Name of field by which to sort records

sortDirectionenumOptional

Sort direction - asc (ascending) or desc (descending)

Allowed values:

idsstringOptional

The Record Ids param (ids) is a list of record ids that can be passed to several record endpoints allowing the user to identify specific records to INCLUDE in the query, or specific records to EXCLUDE, depending on whether or not filters are being applied. When passing a query param that filters the record dataset, such as ‘searchValue’, or a ‘filter’ of ‘valid’ | ‘error’ | ‘all’, the ‘ids’ param will EXCLUDE those records from the filtered results. For basic queries that do not filter the dataset, passing record ids in the ‘ids’ param will limit the dataset to INCLUDE just those specific records

The Record Ids param (ids) is a list of record ids that can be passed to several record endpoints allowing the user to identify specific records to INCLUDE in the query, or specific records to EXCLUDE, depending on whether or not filters are being applied. When passing a query param that filters the record dataset, such as 'searchValue', or a 'filter' of 'valid' | 'error' | 'all', the 'ids' param will EXCLUDE those records from the filtered results. For basic queries that do not filter the dataset, passing record ids in the 'ids' param will limit the dataset to INCLUDE just those specific records

qstringOptional

An FFQL query used to filter the result set

silentbooleanOptional

Whether to suppress events for this bulk update

Request

This endpoint expects an object.

fieldUpdatesmap from strings to objectsRequired

A map of field keys to cell values that will be applied to all matching records

Response

This endpoint returns an object.

dataobject

1	import { FlatfileClient } from "@flatfile/api";
2
3	const client = new FlatfileClient({ token: "YOUR_TOKEN" });
4	await client.records.bulkUpdate("us_sh_YOUR_ID", {
5	fieldUpdates: {
6	"status": {
7	value: "completed"
8	},
9	"processedAt": {
10	value: "2023-11-20T16:59:40.286Z"
11	}
12	}
13	});