Campaigns

Pause a campaign

View as Markdown

Queues a pause task and returns immediately — the campaign is not immediately paused. Poll GET /campaign/{id} and watch for status: "paused".

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

Pause task queued successfully
statusboolean

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error