Pause a campaign

Pause a running campaign. New dials stop, in-flight calls finish, and the campaign requires an explicit resume.

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

Pause a campaign

cURL

curl --request POST \
  --url https://api.vobiz.ai/api/v1/account/{account_id}/campaigns/{campaign_id}/pause \
  --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}/pause

Stops new dials. Calls already in flight complete normally. Allowed only from running.

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 pause. It must be running.

Example

cURL

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

A manual pause sets paused_reason to manual_pause and sends the campaign.paused webhook when notify_url is configured. It requires an explicit resume — it will not restart on its own.

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.