DialerBee APIv1 · 1.0.0-rc6

Campaigns

Resume a paused campaign (Tier 2: starts real calls)

POST /v1/campaigns/{campaign_id}/resume

Scope
campaigns:resume
Tier
Tier 2 (reaches or unlocks real people)
Data
Account data
Idempotency
Idempotency-Key: required

Tier 2. This operation can reach or unlock real people. It needs the scope campaigns:resume and the account switch tier2_campaign_resume_enabled, which is off for every account unless DialerBee turns it on at your request. Until then it answers 403 tier_not_enabled. Daily cap: set before launch.

TIER 2. Starts real calls to real people. Needs the campaigns:resume scope AND the account switch tier2_campaign_resume_enabled (off unless DialerBee turned it on). Resuming a running campaign answers 200 and changes nothing. The body must be empty or {}.

Parameters

NameInTypeRequiredDescription
campaign_idpathstring (CampaignId)yes
Idempotency-KeyheaderstringyesYour unique value for this logical operation (a UUID is fine). Scoped to your API client, kept 24 hours. (min length 1; max length 255)
X-Correlation-IDheaderstringnoYour own trace value, logged with the request. Metadata only, never identity. (min length 1; max length 128)

Request body

Empty, or {}.

JSON: EmptyRequest (optional)

Response

200: The campaign, now running.

HeaderMeaning
X-Request-IDThe DialerBee request id. Quote it to support. Every response carries X-Request-ID: req_<ULID>, or edge_<32 hex> when the edge answered before the request reached the API.
Cache-ControlAlways no-store.
Idempotency-Replayedtrue when this answer is the stored answer of an earlier request with the same Idempotency-Key.

Examples

Request example

curl

curl -sS -X POST \
  "https://app.dialerbee.com/api/v1/campaigns/cmp_0f8fad5b-d9cb-469f-a165-70867728950e/resume" \
  -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.campaigns.resume(
    "cmp_0f8fad5b-d9cb-469f-a165-70867728950e",
    idempotency_key="5f2b7c1e-8a3d-4c6f-9b0e-2d4a6c8e1f3a",
)

Response example

200

{
  "id": "cmp_0f8fad5b-d9cb-469f-a165-70867728950e",
  "name": "Autumn renewals",
  "status": "running",
  "dialer_mode": "progressive",
  "created_at": "2026-09-29T09:15:00Z",
  "updated_at": "2026-09-29T09:20:00Z",
  "started_at": "2026-09-29T11:58:00Z",
  "completed_at": null
}

Error examples

409 campaign_not_paused

{
  "type": "https://docs.dialerbee.com/errors/campaign-not-paused",
  "title": "Campaign not paused",
  "status": 409,
  "detail": "Only a paused campaign can be resumed.",
  "instance": "urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C",
  "code": "campaign_not_paused",
  "request_id": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C"
}

409 registry_stale_blocked

{
  "type": "https://docs.dialerbee.com/errors/registry-stale-blocked",
  "title": "Launch blocked by do-not-call list status",
  "status": 409,
  "detail": "The campaign has leads in a country whose national do-not-call list is out of date, never loaded or not available, and the account has chosen to block a launch in that case.",
  "instance": "urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C",
  "code": "registry_stale_blocked",
  "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"
}

Errors

StatusCodeTitle
401invalid_api_keyInvalid API key
403api_access_disabledAPI access disabled
403ip_not_allowedIP address not allowed
403insufficient_scopeNot permitted
403tier_not_enabledCapability not enabled
400credential_in_urlCredential in URL
400credential_in_bodyCredential in body
400, 422validation_failedInvalid request
413payload_too_largePayload too large
415unsupported_media_typeUnsupported media type
400idempotency_key_requiredIdempotency-Key required
404not_foundNot found
409campaign_not_pausedCampaign not paused
409registry_stale_blockedLaunch blocked by do-not-call list status
409conflictRequest in progress
409idempotency_conflictIdempotency key reused
409outcome_unknownOutcome unknown
429rate_limit_exceededToo many requests
429daily_cap_reachedDaily limit reached
503temporarily_unavailableTemporarily unavailable
503upstream_unavailableTemporarily unavailable
502upstream_invalid_responseUpstream error
500internal_errorInternal error

Objects

EmptyRequest

An empty JSON object.

Campaign

FieldTypeRequiredDescription
idstring (CampaignId)yesA campaign. cmp_ + a lower-case UUID.
namestringyes
statusstringyes
dialer_modestringyes
created_atstring (date-time)yes
updated_atstring (date-time) or nullyes
started_atstring (date-time) or nullyes
completed_atstring (date-time) or nullyes