Callbacks

Schedule a callback (Tier 2: schedules a real call)

POST /v1/callbacks

Scope

callbacks:write

Tier

Tier 2 (reaches or unlocks real people)

Data

Personal data

Idempotency

Idempotency-Key: required

TIER 2. When due, the platform calls the lead. Needs the callbacks:write scope and the account switch tier2_callback_write_enabled.

Parameters

Request body

The lead and the time.

JSON: CallbackCreateRequest

Response

201: The callback.

Examples

Request example

curl

curl -sS -X POST \
  "https://app.dialerbee.com/api/v1/callbacks" \
  -H "Authorization: Bearer $DIALERBEE_API_KEY" \
  -H 'Idempotency-Key: 5f2b7c1e-8a3d-4c6f-9b0e-2d4a6c8e1f3a' \
  -H "Content-Type: application/json" \
  --data '{
  "lead_id": "lead_0f8fad5b-d9cb-469f-a165-70867728950e",
  "scheduled_at": "2026-10-01T14:00:00Z",
  "notes": "Prefers calls after 5 pm."
}'

Python (SDK)

from dialerbee import DialerBee

db = DialerBee()  # reads DIALERBEE_API_KEY from the environment

result = db.callbacks.create(
    lead_id="lead_0f8fad5b-d9cb-469f-a165-70867728950e",
    scheduled_at="2026-10-01T14:00:00Z",
    notes="Prefers calls after 5 pm.",
    idempotency_key="5f2b7c1e-8a3d-4c6f-9b0e-2d4a6c8e1f3a",
)

Response example

201

{
  "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": "pending",
  "notes": "Prefers calls after 5 pm.",
  "created_at": "2026-09-29T09:15:00Z"
}

Error examples

422 on_dnc

{
  "type": "https://docs.dialerbee.com/errors/on-dnc",
  "title": "Destination is on DNC",
  "status": 422,
  "detail": "The number is on the account's Do-Not-Call list, so this action is refused.",
  "instance": "urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C",
  "code": "on_dnc",
  "request_id": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C"
}

403 tier_not_enabled

{
  "type": "https://docs.dialerbee.com/errors/tier-not-enabled",
  "title": "Capability not enabled",
  "status": 403,
  "detail": "This operation can reach or unlock real people.",
  "instance": "urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C",
  "code": "tier_not_enabled",
  "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

CallbackCreateRequest

Callback