v1

latestOpenAPI 3.1.02026-08-04222461539.5 KB

jobs

Preview a mutation

Preview the results of a mutation

post/jobs/preview-mutation

Headers

Authorizationstring required

Bearer authentication

X-Disable-Hooks'true' required

Request body

sheetIdstring required

Sheet ID

mutateRecordstring required

A JavaScript function that will be run on each record in the sheet, it should return a mutated record.

mutationIdstring

If the mutation was generated through some sort of id-ed process, this links this job and that process.

snapshotLabelstring

If specified, a snapshot will be generated with this label

snapshotIdstring

The generated snapshotId will be stored here

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

Options to filter records

filterFieldstring

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

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

qstring

idsTypeCommonsRecordId[]

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

Response

Response with status 200