POST/campaigns/:campaignId/start
Unified start or resume. 0 credits. Rate class: campaign_control.
Behavior
| Current status | Result | Body |
|---|---|---|
READY_TO_SEND | Starts → CAMPAIGN_IN_PROGRESS | templateId required |
CAMPAIGN_PAUSED | Resumes → CAMPAIGN_IN_PROGRESS | uses assignedTemplateId; body optional |
| other | 400 validation_error | — |
Request
POST /campaigns/search-xyz/start
X-API-Key: sk_live_...
Content-Type: application/json
{
"templateId": "tmpl_abc"
}
Response
{
"campaignId": "search-xyz",
"status": "CAMPAIGN_IN_PROGRESS",
"action": "started"
}
action is "started" or "resumed". Create agents/templates in the NotiQ app, then pass templateId.
Errors
| Error code | When |
|---|---|
not_found | Unknown campaign or template |
account_disconnected | Gmail missing/disconnected on agent |
upstream_unavailable | Temporary failure |
MCP
Tool: start_campaign.