Cancel a campaign

Permanently stop a running or paused campaign. Remaining contacts are never dialled and the campaign cannot be restarted.

POST /api/v1/account/{account_id}/campaigns/{campaign_id}/cancel

Cancel a campaign

cURL

curl --request POST \
  --url https://api.vobiz.ai/api/v1/account/{account_id}/campaigns/{campaign_id}/cancel \
  --header 'X-Auth-ID: <x-auth-id>' \
  --header 'X-Auth-Token: <api-key>'

POST https://api.vobiz.ai/api/v1/account/{account_id}/campaigns/{campaign_id}/cancel

Permanently stops remaining work. Allowed from running or paused.

Authentication required

• X-Auth-ID — your Vobiz account ID
• X-Auth-Token — your Vobiz auth token

account_id · string · required

Your Vobiz account ID. Use the same value in X-Auth-ID.

X-Auth-ID · string · required

Your Vobiz account ID, for example MA_XXXXXXXX.

campaign_id · string · required

The campaign to cancel. It must be running or paused.

Example

cURL

curl -X POST \
  "https://api.vobiz.ai/api/v1/account/{account_id}/campaigns/{campaign_id}/cancel" \
  -H "X-Auth-ID: {account_id}" \
  -H "X-Auth-Token: {auth_token}"

Sends the campaign.cancelled webhook when notify_url is configured. Contacts, CDRs, and statistics are preserved — you can still download results.

Cancellation is irreversible. No further contacts are dialled and the campaign cannot be restarted. Verify the account and campaign ID before sending the request.

Lifecycle

draft ──upload──▶ ready ──start/schedule──▶ running ──▶ completed
                     │                       │  ▲
                     │                       ▼  │
                     │                     paused
                     │                       │
                     └───────────────────────┴──▶ cancelled

non-running campaign ──archive──▶ archived

Invalid transitions return 409 Conflict. Control endpoints take no request body.