Callbacks

Cancel a pending callback

POST /v1/callbacks/{callback_id}/cancel

Scope

callbacks:cancel

Tier

Tier 1

Data

Account data

Idempotency

Idempotency-Key: required

Cancelling only removes a planned call, so it is Tier 1: the callback is cancelled and the lead is no longer scheduled for it. Cancelling a callback that is already cancelled answers 200 and changes nothing. The body must be empty or {}.

Parameters

Request body

Empty, or {}.

JSON: EmptyRequest (optional)

Response

200: The callback, now cancelled.

Examples

Request example

curl

curl -sS -X POST \
  "https://app.dialerbee.com/api/v1/callbacks/cb_0f8fad5b-d9cb-469f-a165-70867728950e/cancel" \
  -H "Authorization: Bearer $DIALERBEE_API_KEY" \
  -H 'Idempotency-Key: 5f2b7c1e-8a3d-4c6f-9b0e-2d4a6c8e1f3a' \
  -H "Content-Type: application/json" \
  --data '{}'

Python (SDK)

from dialerbee import DialerBee

db = DialerBee()  # reads DIALERBEE_API_KEY from the environment

result = db.callbacks.cancel(
    "cb_0f8fad5b-d9cb-469f-a165-70867728950e",
    idempotency_key="5f2b7c1e-8a3d-4c6f-9b0e-2d4a6c8e1f3a",
)

Response example

200

{
  "id": "cb_0f8fad5b-d9cb-469f-a165-70867728950e",
  "lead_id": "lead_0f8fad5b-d9cb-469f-a165-70867728950e",
  "campaign_id": "cmp_0f8fad5b-d9cb-469f-a165-70867728950e",
  "scheduled_at": "2026-10-01T14:00:00Z",
  "status": "cancelled",
  "notes": "Prefers calls after 5 pm.",
  "created_at": "2026-09-29T09:15:00Z"
}

Error examples

409 callback_not_pending

{
  "type": "https://docs.dialerbee.com/errors/callback-not-pending",
  "title": "Callback not pending",
  "status": 409,
  "detail": "Only a pending callback can be cancelled or rescheduled.",
  "instance": "urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C",
  "code": "callback_not_pending",
  "request_id": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C"
}

403 insufficient_scope

{
  "type": "https://docs.dialerbee.com/errors/insufficient-scope",
  "title": "Not permitted",
  "status": 403,
  "detail": "The API client does not hold the scope this operation requires.",
  "instance": "urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C",
  "code": "insufficient_scope",
  "request_id": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C"
}

409 outcome_unknown

{
  "type": "https://docs.dialerbee.com/errors/outcome-unknown",
  "title": "Outcome unknown",
  "status": 409,
  "detail": "An earlier request with this Idempotency-Key may or may not have taken effect: the platform did not confirm it.",
  "instance": "urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C",
  "code": "outcome_unknown",
  "request_id": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C"
}

Errors

Objects

EmptyRequest

An empty JSON object.

Callback