API ReferenceFlags

Bulk Mutate

Performs bulk flag operations on records

Path parameters

workbookIdstringRequired
The workbook ID to manage flags for

Headers

AuthorizationstringRequired

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

X-Disable-Hooks"true"Required

Request

This endpoint expects an object.
operationenumRequired
The operation to perform
Allowed values:
slugstringRequired
The flag slug to operate on
flagobjectOptional

Flag data for apply/update operations

exceptionslist of stringsOptional
Record IDs to exclude from the operation
querystringOptional
Query string to filter records
filteranyOptional
Filter object to apply to records
filterFieldstringOptional
Field to filter on
searchValuestringOptional
Value to search for
searchFieldstringOptional
Field to search in
qstringOptional
General search query
idslist of stringsOptional
Specific record IDs to target
snapshotLabelstringOptional
Label for snapshot before mutation

Response

This endpoint returns an object.
successboolean
Whether the operation was successfully queued
jobIdstring
The ID of the job handling the bulk mutation