Skip to main content
POST
Legacy alias: create a campaign (use POST /tables/{tableId}/campaigns)

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string

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

Required string length: 1 - 255
Pattern: ^[\x21-\x7e]{1,255}$

Path Parameters

tableId
string<uuid>
required

Body

application/json
instructions
string
required

Free-form description of the campaign to draft.

Required string length: 1 - 10000
autoLeadRefillEnabled
boolean

Auto Lead Refill at birth. Defaults ON when omitted. Pass false to create the campaign without daily sourcing. Applied to the created campaign as the run settles; read settings.autoLeadRefillEnabled on the campaign to confirm the value before launching.

autoTopUpEnabled
boolean
deprecated

Pre-rename spelling of autoLeadRefillEnabled. Still accepted; autoLeadRefillEnabled wins when both are sent.

Response

{ agent, run, table }: run admitted, work runs in background.