v1

latestOpenAPI 3.1.02026-08-04222461539.5 KB

records

Finds and replaces field values matching search criteria

Searches for all values that match the 'find' value (globally or for a specific field via 'fieldKey') and replaces them with the 'replace' value. Wrap 'find' value in double quotes for exact match (""). Returns a commitId for the updated records

put/sheets/{sheetId}/find-replace

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

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

Headers

Authorizationstring required

Bearer authentication

X-Disable-Hooks'true' required

Request body

fieldKeystring required

A unique key used to identify a field in a sheet

Response

Response with status 200