Trillet AI logo

Cancel Batch Contact

Cancel the batch job for one phone number.

DELETEhttps://api.trillet.ai/v1/api/batch-calls/{batchId}/contacts/{phone}

Headers

x-workspace-idstringrequired

Workspace identifier for the API.

Path Parameters

batchIdstringrequired

The batch that contains the contact.

phonestringrequired

Phone number of the contact to cancel, in the E.164 form stored on the batch (for example +14155550123). URL-encode it.

Behavior and Response

The contact is resolved to its current job (including a pending smart-callback retry), and then handled exactly like Cancel Batch Job: same response fields (ok, reason, message, jobId, phone, callStatus) and the same status codes:

HTTP statusreason
200cancelled (removed from the queue, or retries cancelled after the call already finished), call_in_progress (the live call continues; future retries are cancelled)
404call_not_found (no such number in this batch), or {"error": "Batch not found"}
409already_cancelled
500{"ok": false, "error": "..."}

Example

curl -X DELETE "https://api.trillet.ai/v1/api/batch-calls/k3j9x0a1bq/contacts/%2B14155550123" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-workspace-id: YOUR_WORKSPACE_ID"

URL-encode the phone number. A leading + is %2B.

Last updated on