Agents Platform

Cancel A Batch Call.

Cancel a running batch call and set all recipients to cancelled status.

post/v1/convai/batch-calling/{batch_id}/cancel

Path parameters

batch_idstring required

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Response

Successful Response

idstring required

phone_number_idstring nullable required

phone_provider'twilio' | 'sip_trunk' | 'exotel' required

namestring required

agent_idstring required

branch_idstring nullable required

environmentstring nullable required

created_at_unixinteger required

scheduled_time_unixinteger required

timezonestring nullable required

total_calls_dispatchedinteger required

total_calls_scheduledinteger required

total_calls_finishedinteger required

last_updated_at_unixinteger required

status'pending' | 'in_progress' | 'completed' | 'failed' | 'cancelled' required

retry_countinteger required

target_concurrency_limitinteger nullable required

Maximum number of simultaneous calls for this batch. When set, dispatch is governed by this limit rather than workspace/agent capacity percentages.

agent_namestring required

branch_namestring nullable required

Changes

Changed in 2 of the 49 revisions of this API.2

Sep 3, 20267ac648a154bb1See the full diff
- ○
  added the optional property / to the response with the status
  response-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 26, 2026494d96419d151See the full diff
- ○
  added the optional property / to the response with the status
  response-optional-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history