On this page

POST/campaigns/:campaignId/start

Unified start or resume. 0 credits. Rate class: campaign_control.

Behavior

Current statusResultBody
READY_TO_SENDStarts → CAMPAIGN_IN_PROGRESStemplateId required
CAMPAIGN_PAUSEDResumes → CAMPAIGN_IN_PROGRESSuses assignedTemplateId; body optional
other400 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 codeWhen
not_foundUnknown campaign or template
account_disconnectedGmail missing/disconnected on agent
upstream_unavailableTemporary failure

MCP

Tool: start_campaign.