Campaigns

Start or resume a campaign

View as Markdown
Queues the campaign for processing and returns immediately — the campaign is **not** yet running when the 202 is returned. Poll `GET /campaign/{id}` and watch for `status: "running"`. This endpoint also acts as a **resume** endpoint: if the campaign is currently paused, calling this endpoint resumes it (`status` transitions from `paused` → `running`).

Authentication

AuthorizationBearer

API key from the console ApiKey collection, sent as Bearer token. Also accepts session cookies for browser-based auth.

Path parameters

idstringRequired
The ID of the campaign

Response

Campaign queued for processing
statusboolean
dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error