/api/v1/object/data/{objectSlug}/bulk-actions/{jobId}/cancelCancel a queued or running bulk job.
Cancel a queued or running bulk job.
No request body. Stops the records not yet processed; records already
written stay written. The job's report is returned with status
cancelled, and succeeded counts the records that were written. Only
the user who started the job can cancel it.
Scope: update.<object slug>, for example update.contacts.
Errors:
403— another user started this job (code: BULK_JOB_NOT_YOURS).404— no job has that id, or its report has expired (code: BULK_JOB_NOT_FOUND).409— the job already finished (code: BULK_JOB_ALREADY_FINISHED).
Response 200:
{
"status": 200,
"message": "Bulk action cancelled",
"data": {
"job_id": "d41c7b9e2a60",
"status": "cancelled",
"kind": "update",
"object_slug": "contacts",
"total": 1200,
"succeeded": 500,
"failed": [],
"created_slugs": [],
"chunks_done": 1,
"chunks_total": 3,
"started_by": 17,
"started_at": "2026-09-14T10:00:00.000Z",
"finished_at": null
}
}
Send request
Use the documented inputs to call this endpoint directly.
Parameters
Values are applied to the request and the example on the right.
Responses
Successful response
{
"message": "string",
"data": "string"
}Bad request
{
"status": 1,
"message": "string",
"code": "string",
"data": {}
}The HTTP status code of the response.
What went wrong. Several validation messages are joined with ", ".
A stable, machine-readable reason. Only some errors set it.
Extra detail about the error. Only some errors set it.
Unauthorized
{
"status": 1,
"message": "string",
"code": "string",
"data": {}
}The HTTP status code of the response.
What went wrong. Several validation messages are joined with ", ".
A stable, machine-readable reason. Only some errors set it.
Extra detail about the error. Only some errors set it.
Internal server error
{
"status": 1,
"message": "string",
"code": "string",
"data": {}
}The HTTP status code of the response.
What went wrong. Several validation messages are joined with ", ".
A stable, machine-readable reason. Only some errors set it.
Extra detail about the error. Only some errors set it.
Powered by heyo-docs