cancel_pending query parameter to also cancel all pending leads.
Path Parameters
Query Parameters
Valid Status Transitions
Response
Returns the full updated campaign object withstatus: "stopped" and run_end_at_utc set.
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
cancel_pending query parameter to also cancel all pending leads.
| Parameter | Type | Description |
|---|---|---|
id | integer | The campaign ID. |
| Parameter | Type | Default | Description |
|---|---|---|---|
cancel_pending | boolean | false | If true, all leads in pending state will be set to canceled. |
| From | To |
|---|---|
running | stopped |
paused | stopped |
status: "stopped" and run_end_at_utc set.
{
"success": true,
"data": {
"id": 1,
"organization_id": 1,
"assistant_id": 5,
"from_phone_number": "+15551234567",
"name": "Q1 Customer Outreach",
"status": "stopped",
"timezone": "America/New_York",
"run_start_at_utc": "2025-01-15T14:00:00",
"run_end_at_utc": "2025-01-20T18:45:00",
"daily_window_start_local": "09:00",
"daily_window_end_local": "17:00",
"max_concurrent": 5,
"min_interval_seconds": 10,
"amd_enabled": true,
"amd_options": {},
"voicemail_drop_enabled": true,
"voicemail_drop_media_uri": "sound:custom/vm-greeting",
"consent_enabled": false,
"consent_media_uri": null,
"consent_timeout_seconds": 5,
"settings": {},
"created_at": "2025-01-10T14:30:00",
"updated_at": "2025-01-20T18:45:00"
}
}