Cancel a call

POST/v1/calls/{id}/cancel

Stop a call: a queued or scheduled call never dials, a live call ends with the agent saying goodbye, and a repeating series places no more.

Used in Payer calls1 use case

Cancel is how your queue closes the loop from its side: the claim paid on the 835 before the call went out, a person already called, the ticket was closed. The call answers with status canceled and your reason in ended_reason, and call.canceled goes to your endpoints. A call that has already ended answers 409 conflict. In the Daybook app, Hang up on the Live calls page does the same for a call on the line, for the item's owner and the firm's leads. See Payer calls.

Call this with AIA brief with this endpoint's request, response and auth, ready for a typed client in your language.

Path parameters

idstringrequired
The call id. For a repeating series, any call in it stops the series.

Body

reasonstring
Why, for the call's record and your logs. Up to 200 characters. Never spoken on the call.

Try itEdit the fields and copy the request. Nothing is sent from this page.

API keykept in this tab; masked on screen, copied in full

idpath, stringrequired

reasonstring

curl -X POST https://api.daybookhealthcare.com/v1/calls/call_01JBX8M4Q2T7/cancel \
  -H "Authorization: Bearer $DAYBOOK_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
    "reason": "Paid on the 835 of 2026-10-30"
  }'

Response

idstring
Unique id, prefixed call_.
objectstring
Always call.
statusstring
Where the call is, in order: queued, dialing, navigating (the phone tree), on_hold, with_rep, then completed, failed or canceled.
ended_reasonstring
Why the call ended short of an answer. For a cancel, the reason you sent.
metadataobject
Your keys, echoed back.

curl -X POST https://api.daybookhealthcare.com/v1/calls/call_01JBX8M4Q2T7/cancel \
  -H "Authorization: Bearer $DAYBOOK_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
    "reason": "Paid on the 835 of 2026-10-30"
  }'

Response 200

{
  "id": "call_01JBX8M4Q2T7",
  "object": "call",
  "status": "canceled",
  "payer": "bayline",
  "call_type": "claim_status",
  "mode": "autonomous",
  "hold_seconds": 0,
  "claim": {
    "patient_control_number": "A-10442-1",
    "payer_claim_number": null
  },
  "handoff": null,
  "answer": null,
  "ended_reason": "Paid on the 835 of 2026-10-30",
  "transcript_url": null,
  "recording_url": null,
  "repeat_of": null,
  "next_run_at": null,
  "metadata": {
    "account": "A-10442",
    "ticket": "TCK-55821"
  },
  "created_at": "2026-10-29T14:02:11Z"
}