Deletes the batch and all of its tasks, so pending tasks are never dialled. Calls the batch already placed are kept, with their batch_call_id cleared. The deletion is written to the audit log.
Request#
| Field | Type | Required | Description |
|---|---|---|---|
id |
string | Yes | Path parameter. The batch_call_id. |
Example request#
curl -X DELETE https://api.tried.com.au/delete-batch-call/batch_call_5f2a9c1e7b3d4a6f8e0b1c2d \
-H "Authorization: Bearer $TRIED_API_KEY"const id = "batch_call_5f2a9c1e7b3d4a6f8e0b1c2d";
await fetch(`https://api.tried.com.au/delete-batch-call/${id}`, {
method: "DELETE",
headers: { Authorization: `Bearer ${process.env.TRIED_API_KEY}` },
});import os, requests
batch_id = "batch_call_5f2a9c1e7b3d4a6f8e0b1c2d"
requests.delete(
f"https://api.tried.com.au/delete-batch-call/{batch_id}",
headers={"Authorization": f"Bearer {os.environ['TRIED_API_KEY']}"},
)Response#
204 No Content with an empty body.
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.