Campaigns

Pause a running campaign

POST /v1/campaigns/{campaign_id}/pause

Scope

campaigns:pause

Tier

Tier 1

Data

Account data

Idempotency

Idempotency-Key: required

Idempotent: pausing a campaign that is already paused answers 200 with its state and changes nothing. Any state other than running or paused answers 409 campaign_not_running. The body must be empty or {}.

Parameters

Request body

Empty, or {}.

JSON: EmptyRequest (optional)

Response

200: The campaign, now paused.

Examples

Request example

curl

curl -sS -X POST \
  "https://app.dialerbee.com/api/v1/campaigns/cmp_0f8fad5b-d9cb-469f-a165-70867728950e/pause" \
  -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.pause(
    "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": "paused",
  "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_running

{
  "type": "https://docs.dialerbee.com/errors/campaign-not-running",
  "title": "Campaign not running",
  "status": 409,
  "detail": "Only a running campaign can be paused.",
  "instance": "urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C",
  "code": "campaign_not_running",
  "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.

Campaign