Stop batch call

Stop a batch call and cancel every task that has not been dialled.

POSThttps://api.tried.com.au/stop-batch-call/{id}

Sets the batch to stopped and marks every pending task as cancelled. Calls already placed keep running. A stopped batch is not dialled again, and Start batch call only accepts drafts, so it cannot be restarted.

Request#

Field	Type	Required	Description
`id`	string	Yes	Path parameter. The `batch_call_id`.

This endpoint takes no body.

Example request#

curl -X POST https://api.tried.com.au/stop-batch-call/batch_call_5f2a9c1e7b3d4a6f8e0b1c2d \
  -H "Authorization: Bearer $TRIED_API_KEY"

const id = "batch_call_5f2a9c1e7b3d4a6f8e0b1c2d";
const res = await fetch(`https://api.tried.com.au/stop-batch-call/${id}`, {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.TRIED_API_KEY}` },
});
const result = await res.json();

import os, requests

batch_id = "batch_call_5f2a9c1e7b3d4a6f8e0b1c2d"
res = requests.post(
    f"https://api.tried.com.au/stop-batch-call/{batch_id}",
    headers={"Authorization": f"Bearer {os.environ['TRIED_API_KEY']}"},
)
result = res.json()

Response#

200 OK

{
  "batch_call_id": "batch_call_5f2a9c1e7b3d4a6f8e0b1c2d",
  "status": "stopped",
  "cancelled_tasks": 130
}

Field	Type	Description
`status`	string	Always `stopped`.
`cancelled_tasks`	integer	Number of `pending` tasks moved to `cancelled`.

The endpoint accepts a batch in any status, including draft and sent.

Errors#

Status	When
`401`	Missing or invalid API key.
`403`	The key's IP allowlist or scopes reject the request, or the caller has the read-only member role. This route needs the `calls` scope.
`404`	`Batch call <id> not found`.
`429`	Rate limit exceeded. See Rate limits.

See Errors for the body format.

Retell compatibility#

Retell's API reference documents only Create batch call. This endpoint is a Tried addition.