Skip to main content
POST
Draft a full campaign blueprint from a plain-English goal

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

Idempotency-Key
string

Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.

Required string length: 1 - 255
X-Test-Mode
enum<string>

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

Available options:
true,
false

Body

application/json
goal
string
required

Plain-English campaign goal (5-2,000 chars).

Required string length: 5 - 2000
audience_segment
enum<string>
Available options:
champion,
high_value_engaged,
engaged,
new,
passive,
at_risk,
dormant,
lost
audience_description
string
Maximum string length: 1000
channels
enum<string>[]
Required array length: 1 - 4 elements
Available options:
sms,
whatsapp,
email,
voice
tone
enum<string>
default:friendly
Available options:
professional,
casual,
urgent,
friendly,
empathetic
brand_name
string
Maximum string length: 80
locale
string
default:en
Maximum string length: 10

Response

Successful response.

data
object
meta
object