Cancel Batch Job
Batch Calling
Cancel Batch Job
Cancel a scheduled, pending, or running batch job. Stops new calls and marks remaining contacts as cancelled.
POST
Cancel Batch Job
Overview
Cancels a batch job permanently. Behavior depends on job status:- Scheduled: Cancels Redis scheduled job + updates database
- Pending/Running: Marks remaining contacts as cancelled
- Completed/Failed/Cancelled: Returns error (cannot cancel)
Request
Path Parameters
Response
Response Fields
Examples
Example 1: Cancel Scheduled Job
Example 2: Cancel Running Job
Example 3: Cancel Already Completed Job (Error)
Behavior by Status
Contact Statuses Affected
When cancelling a running job, only contacts in non-terminal statuses are cancelled: Cancelled Statuses:pending— Not yet calledqueued— Waiting for retryno_answer— Will be retriedbusy— Will be retriedtimeout— Will be retried
completed— Already successfulfailed— Final failureblocked— Permanently blockedinvalid_number— Invalid phone numbercarrier_error— Carrier error (final)cancelled— Already cancelled
Error Handling
404 Not Found
400 Bad Request
500 Internal Server Error
Use Cases
Cancel Due to Error in Campaign
If you discover an error in your campaign (wrong message, wrong numbers):Cancel Scheduled Job Before Start Time
Related
- Create Batch Job — Create a new batch job
- Get Batch Job Detail — Get job status
- Start Batch Job — Start scheduled job immediately
- Reschedule Batch Job — Change scheduled time
- Batch Calling Guide — Complete guide to batch campaigns
Authorizations
Your TalkifAI API key. Get it from Studio → Settings → API Keys.