Introduction
IntroductionUpdated February 18, 2025
Introduction
The MachFive API lets you generate personalized cold email sequences from your own apps, scripts, or AI agents. MachFive is a generation platform: we create the email content; you send it via your preferred tool (Instantly, Smartlead, etc.).
What you can do
- List campaigns – Discover campaigns in your workspace (by name or ID).
- Generate for one lead – Send one lead and get back a full sequence (subject + body per step). Request can take 3–10 minutes; use a long timeout.
- Generate for many leads – Send an array of leads; get a
list_idimmediately (202 Accepted). Poll list status, then export CSV or JSON when done. - List status & export – Poll a list until
processing_statusiscompleted, then download results via export.
Conventions
- Base URL:
https://app.machfive.io - Auth:
Authorization: Bearer <API_KEY>or headerX-API-Key: <API_KEY> - Content type:
application/jsonfor request bodies - Field names:
snake_casein JSON (e.g.list_id,processing_status)
Terminology
| Term | Description |
|---|---|
| Campaign | A MachFive campaign (target audience, offer, CTAs). Identified by id. |
| List | One "batch" of leads (from a single generate or generate-batch request). Backed by an internal sequence; API returns list_id. |
| Lead | One prospect: name, title, company, email, etc. |
| Sequence | Array of email steps: { step, subject, body } per step. |