Campaigns

Start or resume a campaign

Changed on

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).

post/campaign/{id}/start

Request

  • Base URL
    https://api.smallest.ai/atoms/v1
  • URL
    https://api.smallest.ai/atoms/v1/campaign/{id}/start
  • Auth
    HTTP bearer

Path parameters

idstring required

The ID of the campaign

Response

Campaign queued for processing

statusboolean

Example response

{
  "status": true,
  "data": {
    "message": "Campaign is being processed"
  }
}

Changes

    • breaking

      removed the success response with the status

    • info

      added the non-success response with the status

    • info

      added the success response with the status