v1

latestOpenAPI 3.1.02026-07-267154122.0 KB
Campaigns

Create a campaign on a table (agentic)

Agentic campaign creation. Minimal body { instructions } — no column or channel; campaigns can be multi-channel and the agent infers the rest from the instructions and the table. Delegates to the chat agent via the v2 run path and responds 202 Accepted with { agent, run, table } (poll GET /agents/{agentId}/runs/{runId} for progress/result). The agent creates the campaign and drafts its sequences (it does not send); once the run completes, the drafted campaign shows up under GET /tables/{tableId}/campaigns. The pre-restructure POST /tables/{tableId}/sequences spelling is the legacy alias.

post/tables/{tableId}/campaigns

Headers

Idempotency-Keystring

Transport-level replay protection — any v2 POST may send it (1–255 printable ASCII characters; UUIDs recommended). The first response for a key is recorded and replayed verbatim for retries with the same key + method/path/body for 24 hours; replayed responses carry the Idempotency-Replay: true response header. Reusing a key with a different request — or retrying while the original is still in flight — returns 409 IDEMPOTENCY_ERROR. 5xx responses are never recorded (the retry re-executes).

Request body

instructionsstring required

Free-form description of the campaign to draft.

Response

Run admitted; the agent drafts the campaign in the background.

Example response

{
  "run": {
    "todo": {
      "pendingQuestions": [
        {
          "freeformOption": "Or something else"
        }
      ]
    }
  }
}