Campaigns

GET /campaigns

Your latest 100 campaigns, newest first, each with people (how many) and done (how many finished).

POST /campaigns

Creates a draft. Only name, employee_id and purpose are required.

• name: up to 120 characters.
• employee_id: from GET /employees.
• purpose: informational (follow-ups and reminders, no selling) or marketing (sales calls, which follow stricter rules).
• brief: what the call is about, up to 4,000 characters. Words in double braces, like {{unit}}, are filled in from each person's variables.
• days: calling days, 0 = Monday to 6 = Sunday. Default Monday to Friday.
• window: { "start": "09:00", "end": "18:00" } in each person's own time zone. Default 09:00 to 20:00, and never outside 9 AM to 8 PM where they live.
• attempts: tries per person, 1 to 9. Default 3.
• concurrency: calls at once, 1 up to your plan's limit. Default 2.
• starts_at: when to start, as an ISO time. Leave it out to start at launch.
• budget_cents: stop when the campaign's calls have cost this much.
• text_on_no_answer: true to send a text when nobody picks up.

{
  "data": {
    "id": "7c3d…", "name": "November renewals", "employee_id": "8f0c…", "purpose": "informational",
    "status": "draft", "paused_reason": null, "brief": "Let {{first_name}} know…",
    "days": [0, 1, 2, 3, 4], "window": { "start": "09:00", "end": "20:00" },
    "attempts": 3, "concurrency": 2, "starts_at": null, "budget_cents": null,
    "text_on_no_answer": false, "launched_at": null, "finished_at": null
  }
}

GET /campaigns/{id}

One campaign with its progress:

{
  "data": {
    "id": "7c3d…", "status": "running", "…": "…",
    "people": 240,
    "by_status": { "done": 112, "waiting": 30, "pending": 95, "blocked": 3 },
    "by_outcome": { "interested": 21, "callback": 9, "not_interested": 40, "no_answer": 42 },
    "spent_cents": 1830
  }
}

• status: draft, scheduled, queued, running, paused, completed or cancelled. paused_reason says why when Nerro paused it, like the budget running out.

Next: add people, then launch.