# Furnace Client API — LLM index (v1.15.0) ## Docs site - Introduction: /docs/ - Quickstart: /docs/guides/quickstart/ - Authentication: /docs/guides/authentication/ - Campaigns: /docs/concepts/campaigns/ - Leads and people: /docs/concepts/leads-people/ - Mailboxes: /docs/concepts/mailboxes/ - Email sequences: /docs/concepts/sequences/ - Webhooks: /docs/concepts/webhooks/ - Campaign setup: /docs/guides/campaign-setup/ - Lead management: /docs/guides/lead-management/ - Handling replies: /docs/guides/handling-replies/ - Webhook integration: /docs/guides/webhook-integration/ - MCP: /docs/guides/mcp/ - Lead added / updated: /docs/webhooks/lead-added-updated/ - Lead lists / export: /docs/webhooks/lead-list-and-export/ - Lead removed: /docs/webhooks/lead-removed/ - Enrollment pause / resume: /docs/webhooks/enrollment-pause-resume/ - Campaign status: /docs/webhooks/campaign-status/ - Email activity: /docs/webhooks/email-activity/ - Block list: /docs/webhooks/block-list/ - FAQ: /docs/guides/faq/ - Changelog: /docs/changelog/ - API Reference: /docs/reference/ ## Machine-readable API - OpenAPI: https://api.getfurnace.io/openapi.json - Full docs corpus: https://api.getfurnace.io/llms-full.txt ## OpenAPI tags - Campaigns: Read and mutate campaigns that belong to the authenticated account. - Flow: Read, validate, and update campaign flow graphs. - Leads: Manage campaign leads, including single-row upserts and bulk imports. - Lead fields: Inspect and extend required lead-field mappings derived from the campaign flow. - Jobs: Create and poll asynchronous bulk jobs (import, add/remove, pause/resume). - People: Account-scoped people explorer and profile updates. - Lead lists: Saved lead lists and list membership. - Mailboxes: Read account mailboxes, manage mailbox tags, and keep secret password fields out of responses. - Inbox: List and triage inbox threads, read messages, send replies and forwards, manage message jobs, out-of-office state, lead replacement, and thread tags. - Block list: List, add, and remove blocked email addresses or domain hosts. A domain entry matches the exact host only (`example.com` → `*@example.com`, not subdomains). - Stats: Read daily and aggregate campaign performance statistics. - Webhooks: Read and update account webhook URL, signing secret, and enabled events. - API keys: List, create, and revoke account API keys. Create returns the secret once. - Meta: Service metadata endpoints. ## Flow object (API Reference) - CampaignFlow — /docs/reference/schemas/CampaignFlow/ - FlowUpdate — /docs/reference/schemas/FlowUpdate/ - FlowValidationIssue — /docs/reference/schemas/FlowValidationIssue/ ## Campaign setup checklist 1. GET /v1/mailboxes — pick a mailbox id to send from 2. POST /v1/campaigns — create a draft 3. POST /v1/campaigns/{id}/flow — add the email sequence 4. POST /v1/campaigns/{id}/leads — add people 5. POST /v1/campaigns/{id}/launch — start sending ## Good to know - Campaigns move draft -> running or scheduled -> paused/stopped - Running allows email copy and timing edits; pause to add/remove/reorder steps - Personalize with {{first_name}} and {{custom.company}} tokens - Read replies via /v1/threads; sending a reply returns a message job to poll - Use webhooks to be notified of sends, replies, and bounces - Full field-level detail lives in the API Reference (openapi.json)