Skip to main content
POST
Score draft campaign content for deliverability (pre-flight)

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
channel
enum<string>
required

Campaign channel the draft content targets.

Available options:
sms,
mms,
whatsapp,
email,
rcs,
viber,
telegram,
line,
messenger,
instagram,
push,
voice,
fax
body
string

Draft message body to score. Defaults to empty string.

Maximum string length: 100000
subject
string

Email-only subject line.

Maximum string length: 500
window
enum<string>

Historical lookback window for the carrier delivery baseline. Defaults to 30d.

Available options:
7d,
30d,
90d

Response

Deliverability pre-flight report

Deliverability pre-flight report

data
object
meta
object