Skip to content

Start, Pause, Stop

POST /api/cc/campaigns/:id/start

POST /api/cc/campaigns/:id/pause

POST /api/cc/campaigns/:id/stop

No request body. Each returns the campaign with its new status.

Action Allowed from Effect
start draft, paused Starts calling. A paused campaign continues where it stopped. Needs at least one number not called yet.
pause running No new calls; calls in progress finish.
stop draft, running, paused Final. No new calls or numbers; calls in progress finish, numbers not called yet become cancelled.

Only one campaign can run on a group at a time: starting a second one returns 409 queue_busy.

Requires a Bearer API token (from Authentication / dashboard API Tokens) and the call-center permission.

Rate limit: 60 requests per minute per account, shared by all Campaign API endpoints.

Terminal window
curl -X POST https://api.awajdigital.com/api/cc/campaigns/42/start \
-H "Authorization: Bearer your_api_token_here" \
-H "Accept: application/json"

Use /pause or /stop in place of /start for the other actions.

{
"data": {
"id": 42,
"name": "October renewals",
"status": "running",
"group_id": 7,
"group_name": "Sales",
"contact_count": 2,
"customer_ring_seconds": 30,
"max_customer_wait_seconds": 20,
"started_at": "2026-10-21T10:05:00.000+06:00",
"stopped_at": null,
"created_at": "2026-10-21T10:00:00.000+06:00"
}
}

The fields are described in Create Campaign.

Status Code Description
401 — Missing or invalid access token
403 — Account does not have the call-center permission
404 campaign_not_found Unknown campaign, or not on your account
409 invalid_status The action is not allowed in the campaign’s status
409 no_contacts Start: no number left to call
409 queue_busy Start: another campaign is running on this group
409 sender_has_no_trunk Start: the group’s number cannot place calls; contact support
409 campaign_stopped · campaign_completed The campaign is already final
429 — Rate limit exceeded (60 requests/minute)
503 engine_unreachable The call engine could not be reached; nothing changed