Skip to main content
POST
/
api
/
v1
/
campaign
/
{campaign_id}
/
pause
Pause Campaign
curl --request POST \
  --url https://app.dograh.com/api/v1/campaign/{campaign_id}/pause
{
  "id": 123,
  "name": "<string>",
  "workflow_id": 123,
  "workflow_name": "<string>",
  "state": "<string>",
  "source_type": "<string>",
  "source_id": "<string>",
  "total_rows": 123,
  "processed_rows": 123,
  "failed_rows": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "retry_config": {
    "enabled": true,
    "max_retries": 123,
    "retry_delay_seconds": 123,
    "retry_on_busy": true,
    "retry_on_no_answer": true,
    "retry_on_voicemail": true
  },
  "max_concurrency": 123,
  "schedule_config": {
    "enabled": true,
    "timezone": "<string>",
    "slots": [
      {
        "day_of_week": 123,
        "start_time": "<string>",
        "end_time": "<string>"
      }
    ]
  },
  "circuit_breaker": {
    "enabled": false,
    "failure_threshold": 0.5,
    "window_seconds": 120,
    "min_calls_in_window": 5
  },
  "executed_count": 0,
  "total_queued_count": 0,
  "parent_campaign_id": 123,
  "redialed_campaign_id": 123,
  "telephony_configuration_id": 123,
  "telephony_configuration_name": "<string>",
  "logs": [
    {
      "ts": "<string>",
      "level": "<string>",
      "event": "<string>",
      "message": "<string>",
      "details": {}
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.dograh.com/llms.txt

Use this file to discover all available pages before exploring further.

Stops dispatching new calls. In-flight calls are not interrupted — they run to completion. Use Resume to continue from where the campaign paused.

Headers

​
authorization
string | null
​
X-API-Key
string | null

Path Parameters

​
campaign_id
integer
required

Response

Successful Response

​
id
integer
required
​
name
string
required
​
workflow_id
integer
required
​
workflow_name
string
required
​
state
string
required
​
source_type
string
required
​
source_id
string
required
​
total_rows
integer | null
required
​
processed_rows
integer
required
​
failed_rows
integer
required
​
created_at
string<date-time>
required
​
started_at
string<date-time> | null
required
​
completed_at
string<date-time> | null
required
​
retry_config
RetryConfigResponse · object
required
​
max_concurrency
integer | null
​
schedule_config
ScheduleConfigResponse · object
​
circuit_breaker
CircuitBreakerConfigResponse · object
​
executed_count
integer
default:0
​
total_queued_count
integer
default:0
​
parent_campaign_id
integer | null
​
redialed_campaign_id
integer | null
​
telephony_configuration_id
integer | null
​
telephony_configuration_name
string | null
​
logs
CampaignLogEntryResponse · object[]