Run a campaign

Create it

Send your list as contacts:

curl -X POST https://app.scalysis.com/api/v1/campaigns \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "scriptId": 2207,
    "name": "July confirmations",
    "maxConcurrency": 5,
    "contacts": [
      { "customerPhone": "9149874123", "customerName": "Rahul", "orderNumber": "ORD-1001" },
      { "customerPhone": "9876543210", "customerName": "Priya", "orderNumber": "ORD-1002" }
    ]
  }'

{
  "success": true,
  "campaign_id": 42,
  "state": "not_started",
  "contact_count": 2,
  "started": false
}

Check contact_count matches your list, then save campaign_id.

Start it

curl -X POST https://app.scalysis.com/api/v1/campaigns/42/control \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "action": "start" }'

Pause or resume any time

Same request with "action": "pause" or "action": "resume". Calls already live finish normally.

Agent uses custom variables?

contacts only carries customerName, orderNumber and orderNotes to the agent. If your agent uses other variables like {brand_name}, send a CSV instead and list the columns the agent should see:

{
  "scriptId": 2207,
  "csvText": "phone_number,customer_name,brand_name\n9149874123,Rahul,Acme Store\n9876543210,Priya,Acme Store",
  "phoneColumn": "phone_number",
  "contextColumnHeaders": ["customer_name", "brand_name"]
}

Column names must match the variable names in the agent. Rows missing a value the agent needs are skipped.

Limits

2,000 contacts per request.
maxConcurrency defaults to 1. Asking above your account limit returns 400.
To start right away, send "startImmediately": true when creating.

Get Started

Core Concepts

Guides

Webhooks

Help

Agent uses custom variables?

Limits

​Agent uses custom variables?

​Limits

Agent uses custom variables?

Limits