v1

latestOpenAPI 3.1.02026-08-04222461539.5 KB

flags

Bulk Mutate

Performs bulk flag operations on records

post/v1/workbooks/{workbookId}/flags/bulk-mutate

Path parameters

workbookIdstring required

Workbook ID

The workbook ID to manage flags for

Headers

Authorizationstring required

Bearer authentication

X-Disable-Hooks'true' required

Request body

operation'apply' | 'update' | 'delete' | 'replace' required

The type of flag operation to perform

slugstring required

The flag slug to operate on

exceptionsstring[]

Record IDs to exclude from the operation

querystring

Query string to filter records

{"stackTrail":"components:schemas:type_flags%3ABulkMutateFlagsRequest:properties:filter","oasType":"schema","type":"unknown","description":"Filter object to apply to records"}

filterFieldstring

Field to filter on

searchValuestring

Value to search for

searchFieldstring

Field to search in

qstring

General search query

idsstring[]

Specific record IDs to target

snapshotLabelstring

Label for snapshot before mutation

Response

Response with status 200

successboolean required

Whether the operation was successfully queued

jobIdstring required

The ID of the job handling the bulk mutation