Skip to main content
POST
Queue a DM campaign

Authorizations

Authorization
string
header
required

A SuperX API key ("sxk_..."), created in the SuperX app under Account > API / MCP / CLI. Keys are server-side secrets.

Headers

Idempotency-Key
string

Unique key (max 64 characters) for safe retries. Replays carry the "Idempotency-Replayed" response header set to "true". Keys are retained for 24 hours.

Maximum string length: 64

Body

application/json
recipients
object[]
required
Required array length: 1 - 100 elements
message
string

The shared message. Required unless every recipient carries its own.

Required string length: 1 - 1000
spread
boolean
default:false

Spread what today's daily allowance cannot hold over the coming days instead of skipping it. Ignored when GET /v1/dm/limits reports scheduling_enabled: false; the overflow is then counted in skipped.

account_id
string

Any account you own, meaning your main account (the default when omitted) or one linked to it. An account shared with you returns 403 writes_main_account_only.

Response

Nothing was queued because every recipient was skipped. data.id is null.

data
object

The result of queueing a campaign. Counts, not deliveries.

note
string