v1

latestOpenAPI 3.1.02026-08-04222461539.5 KB
records

Bulk update records with field values

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.

patch/sheets/{sheetId}/records/bulk-update

Path parameters

sheetIdstring required

Sheet ID

ID of sheet

Query parameters

filter'valid' | 'error' | 'all' | 'none'

Options to filter records

filterFieldstring

Use this to narrow the valid/error filter results to a specific field

Name of field by which to filter records

searchValuestring

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 ("")

searchFieldstring

Use this to narrow the searchValue results to a specific field

sortFieldstring

Name of field by which to sort records

sortDirection'asc' | 'desc'

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

idsstring

Record ID

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

qstring

An FFQL query used to filter the result set

silentboolean

Whether to suppress events for this bulk update

Headers

Authorizationstring required

Bearer authentication

X-Disable-Hooks'true' required

Request body

fieldUpdatesobject required

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

Response

Response with status 200