API overview
Email Sequence Design
email-sequence
Design lifecycle email sequences — welcome, nurture, onboarding, win-back — with per-email jobs, cadence, and subject lines.
Pricing & runtime
- Current price
- 25 Credits per run
- Timeout
- up to 1200s
- Brand Context
- Optional — pass a brand_context_id
Prices are calibrated against real run costs and may change — the credit_cost returned when creating a run is authoritative.
Input parameters
Pass these under the input object of POST /api/v1/runs.
| Key | Type | Required | Label & description |
|---|---|---|---|
| product_description | short_text | Required | ProductWhat the product is. |
| sequence_type | select | Optional | Sequence typeWhich lifecycle flow.Options: Welcome series, Lead nurture, Onboarding, Re-engagement, Win-back |
| audience_context | long_text | Optional | AudienceWho they are, what they know, relationship stage. |
| trigger_context | short_text | Optional | Entry triggerWhat put them in this sequence. |
| conversion_goal | short_text | Optional | Conversion goalThe action that defines success. |
| existing_emails | long_text | Optional | Current emailsPaste your current sequence if improving. |
| interaction_language | select | Optional | Report languageControls the language of the generated report.Options: English, Chinese |
Request example
Covers every required field. Optional fields follow the same pattern.
curl -X POST https://api.TODO-APP-DOMAIN/api/v1/runs \
-H "Authorization: Bearer $SUPAMARKETERS_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"app_slug": "email-sequence",
"input": {
"product_description": "example text"
}
}'What you get back
A 201 response returns run_no, credit_cost, stream_url and result_url (relative paths). Stream progress from stream_url and fetch the terminal result — summary and output — from result_url. Results stay available for the App's retention window (30 days by default).