Cancel a campaign | Voicebip

Terminates the campaign and purges its backlog. Any non-terminal status → cancelled.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

campaign_idstringRequired

Response

Campaign cancelled

idstring

camp_{nanoid}

workspace_idstring

channelenum

agent_idstring

statusenum

configmap from strings to any

Channel payload template (caller-id, call window, webhook). Shape owned by the orchestrator.

schedulemap from strings to any

retry_policymap from strings to any

Retry attempts + backoff (max_attempts, backoff_seconds, backoff_multiplier). Absent = no retries.

countersobject

Live progress counts. total = queued + dispatched + succeeded + failed.

created_atdatetime

updated_atdatetime

started_atdatetime

completed_atdatetime

retryable_failedinteger

Count of targets the Retry failed action would re-queue (genuine dial failures, excluding suppression terminals). Present for completed/paused campaigns; omitted when 0.

Errors

401

Cancel Campaign Request Unauthorized Error

404

Cancel Campaign Request Not Found Error

1	{
2	"id": "id",
3	"workspace_id": "workspace_id",
4	"channel": "voice",
5	"agent_id": "agent_id",
6	"status": "draft",
7	"config": {
8	"key": "value"
9	},
10	"schedule": {
11	"key": "value"
12	},
13	"retry_policy": {
14	"key": "value"
15	},
16	"counters": {
17	"total": 1,
18	"queued": 1,
19	"dispatched": 1,
20	"succeeded": 1,
21	"failed": 1
22	},
23	"created_at": "2024-01-15T09:30:00Z",
24	"updated_at": "2024-01-15T09:30:00Z",
25	"started_at": "2024-01-15T09:30:00Z",
26	"completed_at": "2024-01-15T09:30:00Z",
27	"retryable_failed": 1
28	}

$	curl -X POST https://api.voicebip.com/v1/campaigns/campaign_id/cancel \
>	-H "Authorization: Bearer <token>"