v1

latestOpenAPI 3.1.02026-07-267154122.0 KB
Campaigns

Request a content change to a campaign (agentic)

The ONLY way to change campaign content (message templates, per-lead copy, the brief). Minimal body { instructions } — a natural- language change request the chat agent fulfils. Delegates to the v2 run path and responds 202 Accepted with { agent, run, campaign } (poll GET /agents/{agentId}/runs/{runId}). The API never mutates a template or step directly.

post/campaigns/{campaignId}/edits

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 content change to apply.

Response

Run admitted; the agent applies the change in the background.

Example response

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