post https://api.fulcrumapp.com/api/v2/batch.json
Using the batch operations API, you can bulk update a records status, assignee, and project.
Using the batch operations API, you can bulk update a records status, assignee, and project.
Notes
- Once a batch update has started it CANNOT BE TERMINATED
- Do not include multiple operations within the same batch. Only the first operation will run.
- You will need to include an SQL query that indicates which records you want to delete, and make sure to alias the
_record_id
field asid
. For example, if you wanted to delete all records in an app, your query would be"SELECT \_record_id AS id FROM \"Testing App\""\
- The maximum amount of records that can be deleted at this time is 10,000
Sample request body
{
"batch": {
"start": true,
"operations": [
{
"action": "update",
"data": {
"status": "good"
},
"resource": "record",
"form_id": "a5e0bef4-71b9-11ee-b962-0242ac120002",
"query": "SELECT _record_id AS id FROM \"Testing App\" WHERE _status='update_this'"
}
]
}
}
Sample create batch response
{
"batch": {
"status": "running",
"objects_total": 60,
"objects_success": 0,
"id": "a5e0bef4-71b9-11ee-b962-0242ac120002",
"created_at": "2023-10-16T16:48:14Z",
"updated_at": "2023-10-16T16:48:14Z",
"created_by": "Vincent Lauffer",
"created_by_id": "b774e44c-71b9-11ee-b962-0242ac120002",
"updated_by": "Vincent Lauffer",
"updated_by_id": "b774e44c-71b9-11ee-b962-0242ac120002"
}
}