Skip to main content
POST
Draft outreach messages onto a research dataset

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.

Path Parameters

id
string
required

The dataset id from GET /v1/datasets.

Pattern: ^[A-Za-z0-9_-]{1,64}$

Body

application/json
format
string
required

The template or example message every draft should follow. Keep [name], [first] and [handle] tokens if you want them filled in per recipient at send time.

Required string length: 10 - 1000
instructions
string

Optional extra steer: tone, what to emphasize, what to avoid.

Maximum string length: 500
account_id
string

Which of your accounts to draft as. Omit for the main account.

Response

The messages were drafted and saved onto the dataset.

data
object
meta
object
note
string