# FoxReach Docs

> Documentation for FoxReach, the cold email outreach platform: connect inboxes and warm them up, import and verify leads, build campaigns and sequences, work the unified inbox, and read results, plus the full REST API reference, Python and TypeScript SDKs, CLI, webhooks, and MCP server for AI agents.

- [Getting started with FoxReach](https://www.foxreach.io/docs/get-started/overview.md): A getting started guide for FoxReach: create your account, connect and warm up an email account, import and verify leads, and launch your first cold email campaign, with a full tutorial linked for every step.
- [Connect an email account](https://www.foxreach.io/docs/get-started/connect-email-account.md): How to connect an email account to FoxReach with Google sign-in or an app password: run the connection test, set a safe daily limit, and read the health score.
- [Warm up a new inbox](https://www.foxreach.io/docs/get-started/warm-up-inbox.md): How to turn on email warmup for a new inbox in FoxReach, read the Day X of N ramp and health score, keep warmup mail out of your inbox, and leave it running.
- [Import leads from a CSV](https://www.foxreach.io/docs/get-started/import-leads.md): How to import leads from a CSV into FoxReach in three steps: upload, map columns, review. Covers tags, custom fields, verify on import, duplicates, and limits.
- [Verify emails before you send](https://www.foxreach.io/docs/get-started/verify-emails.md): How to verify emails in FoxReach before a campaign sends: check one lead, a selection of up to 200, or a whole CSV on import, then read the icons and credits.
- [Create a campaign and sequence](https://www.foxreach.io/docs/get-started/create-campaign.md): Build a cold email campaign in FoxReach step by step: schedule, sending accounts, daily limit, a sequence with variables and follow-ups, leads, then Start.
- [Email templates, variables and spintax](https://www.foxreach.io/docs/get-started/email-templates.md): Build reusable email templates in FoxReach with lead variables, fallbacks for missing data, and spintax, then load them into any campaign sequence step.
- [Work the unified inbox](https://www.foxreach.io/docs/get-started/unified-inbox.md): How the FoxReach unified inbox collects every reply from every connected account, sorts it with AI, drafts your answer, and sends it from the right inbox.
- [Read your campaign results](https://www.foxreach.io/docs/get-started/campaign-results.md): How to read campaign results in FoxReach: the dashboard, campaign stats, the Activity tab, healthy reply and bounce rates, and how to share a public report.
- [Personalize emails with your own CSV columns](https://www.foxreach.io/docs/product/custom-fields.md): Any column in your lead spreadsheet that FoxReach has no box for becomes a custom field: how it gets in, where it shows up, and how to use it in an email with a fallback.
- [A/B test subject lines, body copy and follow-ups](https://www.foxreach.io/docs/product/ab-testing.md): A step-by-step guide to A/B testing cold email in FoxReach: how to split any sequence step into weighted variants, what to test at each step, how to read the variant performance table, and how to promote a winner.
- [Set up a custom tracking domain](https://www.foxreach.io/docs/product/tracking-domain.md): A custom tracking domain keeps your sender reputation your own and protects inbox placement. Here is why it matters and how to set one up in FoxReach in about ten minutes.
- [Send a single email from a campaign](https://www.foxreach.io/docs/product/send-single-email.md): How to send one email to one lead from a FoxReach campaign: the Send Email drawer, the three places it opens from, preview text, what it counts against, and which leads it refuses.
- [How unsubscribes work](https://www.foxreach.io/docs/product/unsubscribes.md): The two ways a lead opts out of FoxReach campaigns, what happens to them when they do, the per-campaign unsubscribe header and when it is switched on for you, and why your copy still needs an opt-out line.
- [Workspaces and team members](https://www.foxreach.io/docs/product/workspaces.md): A workspace is the container for everything in FoxReach: leads, campaigns, inboxes, templates, team, and billing. Here is how workspaces work, when to create a second one, and the workspace and seat limits on every plan.
- [Run client workspaces in agency mode](https://www.foxreach.io/docs/product/agency-mode.md): How to run client workspaces in agency mode in FoxReach: the Agency Command Center dashboard, client health cards, team access matrix, branding and limits.
- [Fenn, the AI co-pilot](https://www.foxreach.io/docs/product/fenn.md): Fenn is the AI co-pilot inside FoxReach. Ask it to build a campaign, write the sequence, and add leads, with every change waiting for your approval first.
- [Check cold email copy for spam triggers and typos before you send](https://www.foxreach.io/docs/product/copy-check.md): How to run Copy check on a sequence step, A/B variant or template in FoxReach: what the inbox score and folder prediction mean, how to read the highlighted sentences and words, and how to apply the fixes it offers with one click.
- [API keys and webhooks](https://www.foxreach.io/docs/product/api-keys-and-webhooks.md): Create API keys in FoxReach, call the REST API with the X-API-Key header, add a webhook, verify its HMAC signature, and read the delivery log when it fails.
- [Plans, limits and billing](https://www.foxreach.io/docs/product/plans-and-billing.md): What each FoxReach plan includes, what the limits mean day to day, how to upgrade, change or cancel through the Billing tab, and how verification credits work.
- [Your account settings](https://www.foxreach.io/docs/product/account-settings.md): The Account and Appearance tabs in FoxReach Settings: profile and timezone, passwords and passkeys, the emails FoxReach sends you, the product tour, light and dark mode with colour presets, and deleting your account.
- [Refer & Earn, the FoxReach affiliate program](https://www.foxreach.io/docs/product/referrals.md): How to apply to the FoxReach affiliate program from your account, what your referral link does while your application is reviewed, how commission accrues and gets paid, and where to see all of it.
- [Automate cold email with n8n](https://www.foxreach.io/docs/integrations/n8n.md): Install the FoxReach community node for n8n, connect your API key, and build automation workflows to manage leads and campaigns programmatically.
- [Connect GoHighLevel](https://www.foxreach.io/docs/integrations/gohighlevel.md): A no-code walkthrough for agencies and outbound teams: sync GoHighLevel contacts into FoxReach cold email campaigns and push warm replies back into your CRM using Make, Zapier, n8n, or the FoxReach API.
- [Connect Claude, Cursor and Claude Code with MCP](https://www.foxreach.io/docs/integrations/mcp-clients.md): Set up the FoxReach MCP server to manage leads, campaigns, and templates directly from Claude Desktop, Cursor, or Claude Code using natural language.
- [Claude Code plugin](https://www.foxreach.io/docs/integrations/claude-code-plugin.md): Install the FoxReach Claude Code plugin to manage leads, campaigns, templates, and analytics using natural language directly in your terminal.
- [Introduction](https://www.foxreach.io/docs/introduction.md): Get started with the FoxReach API to manage leads, campaigns, email accounts, templates, and webhooks programmatically.
- [Authentication](https://www.foxreach.io/docs/authentication.md): Learn how to authenticate with the FoxReach API using API keys.
- [Rate Limiting](https://www.foxreach.io/docs/rate-limiting.md): Understand the API rate limits and how to handle them in your integration.
- [Errors](https://www.foxreach.io/docs/errors.md): Understand API error codes and how to handle them in your integration.
- [Versioning](https://www.foxreach.io/docs/versioning.md): How the FoxReach API handles versioning and breaking changes.
- [Changelog](https://www.foxreach.io/docs/changelog.md): Latest updates, new features, and improvements to the FoxReach API.
- [Template Variables & Spin Syntax](https://www.foxreach.io/docs/template-variables.md): Personalize your email templates with dynamic variables and spin syntax for better deliverability.
- [Campaign Setup Guide](https://www.foxreach.io/docs/campaign-setup.md): End-to-end guide for creating and launching a cold email campaign via the FoxReach API.
- [MCP Server](https://www.foxreach.io/docs/mcp-server.md): Connect Claude, Cursor, and other AI agents to FoxReach using the Model Context Protocol (MCP).
- [List Leads](https://www.foxreach.io/docs/api-reference/leads/list-leads.md): Retrieve a paginated list of leads in your workspace.
- [Get Lead](https://www.foxreach.io/docs/api-reference/leads/get-lead.md): Retrieve a single lead by ID.
- [Create Lead](https://www.foxreach.io/docs/api-reference/leads/create-lead.md): Create a new lead in your workspace.
- [Bulk Import Leads](https://www.foxreach.io/docs/api-reference/leads/import-leads.md): Import up to 1000 leads in a single call with automatic soft-delete restoration and a structured dedup report.
- [Update Lead](https://www.foxreach.io/docs/api-reference/leads/update-lead.md): Update an existing lead. Only provided fields are changed.
- [Delete Lead](https://www.foxreach.io/docs/api-reference/leads/delete-lead.md): Permanently delete a lead from your workspace.
- [Get Lead Activity](https://www.foxreach.io/docs/api-reference/leads/get-lead-activity.md): Retrieve the activity timeline and campaign memberships for a lead.
- [List Campaigns](https://www.foxreach.io/docs/api-reference/campaigns/list-campaigns.md): Retrieve a paginated list of campaigns in your workspace.
- [Get Campaign](https://www.foxreach.io/docs/api-reference/campaigns/get-campaign.md): Retrieve a single campaign with its sequence steps.
- [Create Campaign](https://www.foxreach.io/docs/api-reference/campaigns/create-campaign.md): Create a new campaign in draft status.
- [Update Campaign](https://www.foxreach.io/docs/api-reference/campaigns/update-campaign.md): Update campaign settings. Cannot edit while the campaign is active.
- [Delete Campaign](https://www.foxreach.io/docs/api-reference/campaigns/delete-campaign.md): Delete a draft campaign. Only campaigns in draft status can be deleted.
- [Start Campaign](https://www.foxreach.io/docs/api-reference/campaigns/start-campaign.md): Start a campaign, transitioning it from draft or paused to active.
- [Pause Campaign](https://www.foxreach.io/docs/api-reference/campaigns/pause-campaign.md): Pause an active campaign. No more emails will be sent until resumed.
- [Resume Campaign](https://www.foxreach.io/docs/api-reference/campaigns/resume-campaign.md): Resume a paused campaign, transitioning it back to active.
- [List Sequences](https://www.foxreach.io/docs/api-reference/campaigns/list-sequences.md): Retrieve all sequence steps for a campaign, ordered by step number.
- [Create Sequence Step](https://www.foxreach.io/docs/api-reference/campaigns/create-sequence.md): Add a new sequence step to a campaign. Campaign must be in draft or paused status.
- [Update Sequence Step](https://www.foxreach.io/docs/api-reference/campaigns/update-sequence.md): Update a sequence step. Campaign must be in draft or paused status.
- [Delete Sequence Step](https://www.foxreach.io/docs/api-reference/campaigns/delete-sequence.md): Delete a sequence step from a campaign. Campaign must be in draft or paused status.
- [List Campaign Leads](https://www.foxreach.io/docs/api-reference/campaigns/list-campaign-leads.md): Retrieve a paginated list of leads enrolled in a campaign.
- [Add Leads to Campaign](https://www.foxreach.io/docs/api-reference/campaigns/add-campaign-leads.md): Add one or more leads to a campaign by their IDs.
- [Remove Lead from Campaign](https://www.foxreach.io/docs/api-reference/campaigns/remove-campaign-lead.md): Remove a lead from a campaign. Campaign must not be active.
- [List Campaign Accounts](https://www.foxreach.io/docs/api-reference/campaigns/list-campaign-accounts.md): Retrieve the email accounts assigned to a campaign for inbox rotation.
- [Add Accounts to Campaign](https://www.foxreach.io/docs/api-reference/campaigns/add-campaign-accounts.md): Assign email accounts to a campaign for sending and inbox rotation.
- [Remove Account from Campaign](https://www.foxreach.io/docs/api-reference/campaigns/remove-campaign-account.md): Remove an email account from a campaign.
- [List Threads](https://www.foxreach.io/docs/api-reference/inbox/list-threads.md): Retrieve a paginated list of inbox reply threads.
- [Get Conversation](https://www.foxreach.io/docs/api-reference/inbox/get-thread.md): Retrieve the full conversation thread including all sent and received messages.
- [Update Thread](https://www.foxreach.io/docs/api-reference/inbox/update-thread.md): Update a thread's read status, starred status, or category.
- [Send Reply](https://www.foxreach.io/docs/api-reference/inbox/send-reply.md): Send a reply to an inbox thread.
- [Delete Thread](https://www.foxreach.io/docs/api-reference/inbox/delete-thread.md): Delete a reply thread from the inbox.
- [Get Inbox Stats](https://www.foxreach.io/docs/api-reference/inbox/get-stats.md): Retrieve inbox statistics with counts by category.
- [List Email Accounts](https://www.foxreach.io/docs/api-reference/email-accounts/list-accounts.md): Retrieve a paginated list of email accounts in your workspace.
- [Get Email Account](https://www.foxreach.io/docs/api-reference/email-accounts/get-account.md): Retrieve a single email account by ID.
- [Create, Update & Warmup](https://www.foxreach.io/docs/api-reference/email-accounts/manage-account.md): Connect a new email account, update its settings, and manage warmup: all write paths for /api/v1/email-accounts.
- [Delete Email Account](https://www.foxreach.io/docs/api-reference/email-accounts/delete-account.md): Delete an email account from your workspace.
- [Lead Finder](https://www.foxreach.io/docs/api-reference/lead-finder/overview.md): Search a licensed people/company database and reveal verified work emails. Feature-flagged, off by default.
- [Tracking Domains](https://www.foxreach.io/docs/api-reference/tracking-domains/overview.md): Bring your own open/click tracking domain, e.g. track.yourcompany.com.
- [Warmup (Reads)](https://www.foxreach.io/docs/api-reference/warmup/overview.md): Read-only access to your workspace's warmup pool, stats, logs, and tags.
- [Managed Mailboxes (Reads & Quote)](https://www.foxreach.io/docs/api-reference/managed-inboxes/overview.md): Check domain availability, get suggestions and price quotes, and read existing managed mailbox orders.
- [List Templates](https://www.foxreach.io/docs/api-reference/templates/list-templates.md): Retrieve a paginated list of templates in your workspace.
- [Get Template](https://www.foxreach.io/docs/api-reference/templates/get-template.md): Retrieve a single template by ID.
- [Create Template](https://www.foxreach.io/docs/api-reference/templates/create-template.md): Create a new email template.
- [Update Template](https://www.foxreach.io/docs/api-reference/templates/update-template.md): Update an existing template. Only provided fields are changed.
- [Delete Template](https://www.foxreach.io/docs/api-reference/templates/delete-template.md): Delete a template from your workspace.
- [Workspace Overview](https://www.foxreach.io/docs/api-reference/analytics/overview.md): Retrieve workspace-wide analytics including accounts, campaigns, leads, and engagement metrics.
- [Campaign Statistics](https://www.foxreach.io/docs/api-reference/analytics/campaign-stats.md): Retrieve detailed performance metrics for a specific campaign.
- [List Event Types](https://www.foxreach.io/docs/api-reference/webhooks/list-event-types.md): Retrieve the list of valid webhook event types you can subscribe to.
- [List Webhooks](https://www.foxreach.io/docs/api-reference/webhooks/list-webhooks.md): Retrieve a paginated list of webhooks in your workspace.
- [Create Webhook](https://www.foxreach.io/docs/api-reference/webhooks/create-webhook.md): Create a new webhook. A signing secret is auto-generated and returned once.
- [Update Webhook](https://www.foxreach.io/docs/api-reference/webhooks/update-webhook.md): Update an existing webhook's URL, events, or active status.
- [Delete Webhook](https://www.foxreach.io/docs/api-reference/webhooks/delete-webhook.md): Delete a webhook. It will stop receiving events immediately.
- [Python SDK](https://www.foxreach.io/docs/sdks/python.md): Official Python SDK for the FoxReach API. Sync and async support, typed models, auto-pagination.
- [TypeScript / JavaScript SDK](https://www.foxreach.io/docs/sdks/typescript.md): Official TypeScript SDK for the FoxReach API. Zero dependencies, full type safety, auto-pagination.
- [CLI](https://www.foxreach.io/docs/sdks/cli.md): Command-line interface for managing FoxReach leads, campaigns, templates, and more from your terminal.
- [Webhooks Overview](https://www.foxreach.io/docs/webhooks/overview.md): Receive real-time notifications when events happen in your FoxReach account.
- [Event Types](https://www.foxreach.io/docs/webhooks/events.md): Complete reference of all webhook event types you can subscribe to.
- [Signature Verification](https://www.foxreach.io/docs/webhooks/signatures.md): Verify webhook signatures to ensure requests are from FoxReach.

## OpenAPI Specs

- [openapi](/docs/openapi.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.