Skip to main content
POST
/
v1
/
calls
/
batch
/
{campaign_id}
/
launch
Launch batch campaign
curl --request POST \
  --url https://api.nixflex.com/v1/calls/batch/{campaign_id}/launch

Documentation Index

Fetch the complete documentation index at: https://docs.nixflex.com/llms.txt

Use this file to discover all available pages before exploring further.

Launches a scheduled or paused campaign immediately. Use this when you created a campaign with schedule_type: schedule and want to override and start now.

Request

curl -X POST https://api.nixflex.com/v1/calls/batch/camp_a1b2c3d4/launch \
  -H "Authorization: Bearer KEY_ID:KEY_SECRET"
No request body required.

Response

200 OK:
{
  "campaign_id": "camp_a1b2c3d4",
  "status": "running",
  "recipients_count": 100,
  "queued_count": 100
}
The campaign moves from scheduledrunning. Calls start dialling immediately.

Behaviour

  • Already running: no-op, returns current status
  • Already completed: 400 with campaign_already_completed
  • Scheduled in the future: launches immediately, ignores the scheduled time

Errors

CodeCause
campaign_not_foundID doesn’t exist or isn’t yours
campaign_already_completedCampaign finished already
campaign_no_recipientsEmpty recipient list