Key Terms

API Terms

API Key
A unique identifier used to authenticate API requests. Format: mf_live_ followed by 32 characters. Include your API key in the Authorization: Bearer <key> header or X-API-Key header of all requests.

Base URL
The root URL for all API requests. The MachFive API base URL is https://app.machfive.io.

Endpoint
A specific URL path that accepts API requests. Each endpoint represents a specific resource or action in the MachFive API (e.g. /api/v1/campaigns, /api/v1/campaigns/:id/generate).

Request/Response

• Request: An HTTP request sent to an API endpoint with headers and optional body
• Response: The HTTP response returned by the API, typically in JSON format

Content Type
All request bodies use application/json content type.

Field Names
All JSON field names use snake_case (e.g. list_id, processing_status).

MachFive Concepts

Campaign
A MachFive campaign (target audience, offer, CTAs). Identified by id. Use campaigns to generate personalized email sequences.

List
One "batch" of leads (from a single generate or generate-batch request). Backed by an internal sequence; API returns list_id. Use lists to track batch processing status and export results.

Lead
One prospect: name, title, company, email, etc. Leads are sent to the generate or generate-batch endpoints to create personalized sequences.

Sequence
Array of email steps: { step, subject, body } per step. Generated sequences contain personalized cold email content ready to send via your preferred tool.

Workspace
Your MachFive account container. API keys are scoped to a workspace. Contains your campaigns, lists, and settings.