# Happierleads Docs - **Get started** - [Introduction](/docs): What Happierleads does, the five steps to your first leads, and where every feature is explained. - [Getting around the dashboard](/docs/getting-around): The sidebar, search, the account menu, setup progress, help, feedback and the banners at the top of the dashboard. - [Authentication](/docs/authentication): The keys that let your code and your AI assistant act on your account, what each one can reach, and how to replace one. - [Glossary](/docs/glossary): The words you meet in the dashboard and in these docs, in plain English. - **Features** - Leads - [Leads](/docs/leads): Where your leads come from, and everything you can do with one. - **Lead sources** - Website visitors - See your leads - [See your leads](/docs/leads/website-visitors/see-your-leads): Everyone we identified on your website: the person, their company, what they did and how well they fit. - [See your leads from your code](/docs/leads/website-visitors/see-your-leads/api): REST endpoints for your website visitors, authenticated with your API key. - [See your leads with your AI assistant](/docs/leads/website-visitors/see-your-leads/mcp): Ask Claude, ChatGPT or Cursor about your website visitors in plain English. - Choose your columns - [Choose your columns](/docs/leads/website-visitors/columns): Pick which columns the leads table shows, in what order, for each tab. - Filter your leads - [Filter your leads](/docs/leads/website-visitors/filters): Narrow the leads table by period, search, ICP score, traffic source and any field. - [Filter your leads from your code](/docs/leads/website-visitors/filters/api): REST endpoints to filter your website visitors by location, company, behaviour and campaign, authenticated with your API key. - [Filter your leads with your AI assistant](/docs/leads/website-visitors/filters/mcp): Ask Claude, ChatGPT or Cursor to filter your website visitors in plain English. - 3rd-Party Intent - [3rd-Party Intent](/docs/leads/intent-topics): See companies researching the topics you sell into, even before they visit your website. - [3rd-party intent from your code](/docs/leads/intent-topics/api): REST endpoints for 3rd-party intent, authenticated with your API key. - [3rd-party intent with your AI assistant](/docs/leads/intent-topics/mcp): Ask Claude, ChatGPT or Cursor about 3rd-party intent in plain English. - Web Scraping - [Web Scraping](/docs/leads/web-scraping): Keywords we look for on websites — what your buyers write, or a competitor's script — and every match becomes a lead. - [Web Scraping keywords from your code](/docs/leads/web-scraping/api): REST endpoints for web scraping keywords, authenticated with your API key. - [Web Scraping keywords with your AI assistant](/docs/leads/web-scraping/mcp): Ask Claude, ChatGPT or Cursor about web scraping keywords in plain English. - Prospector - Search for prospects - Manual search - [Manual search](/docs/leads/prospector/search-prospects/manual-search): Filter the Happierleads contact database by job title, seniority, industry, location and company size, then add the people you want to your leads. - [Manual search from your code](/docs/leads/prospector/search-prospects/manual-search/api): Search the contact database and reveal emails with the REST API — one POST each, authenticated with your API key. - [Manual search with your AI assistant](/docs/leads/prospector/search-prospects/manual-search/mcp): Ask Claude, ChatGPT or Cursor to find prospects in plain English; it searches your Happierleads account and shows who matches. - Auto Search - [Auto Search](/docs/leads/prospector/search-prospects/auto-search): Describe your ideal customer once; new matching people are added to your leads every day. - [Auto Search from your code](/docs/leads/prospector/search-prospects/auto-search/api): Build, start, list, pause and resume Auto Searches with the REST API, authenticated with your API key. - [Auto Search with your AI assistant](/docs/leads/prospector/search-prospects/auto-search/mcp): Ask Claude, ChatGPT or Cursor to set up, check or pause your Auto Searches in plain English. - Search companies - [Search companies](/docs/leads/prospector/search-companies): Find companies in the Happierleads database by industry, size, location or technology, or look one up by name. - [Search companies from your code](/docs/leads/prospector/search-companies/api): REST endpoint to search the company database by industry, size, revenue, location and technology, authenticated with your API key. - [Search companies with your AI assistant](/docs/leads/prospector/search-companies/mcp): Ask Claude, ChatGPT or Cursor to find companies by industry, size, location or technology in plain English. - Find an email - [Find an email](/docs/leads/prospector/find-email): Look for the email of a person we do not hold one for, by testing and verifying likely addresses. - [Find an email from your code](/docs/leads/prospector/find-email/api): REST endpoint to look for the email of a Prospector contact we hold none for, authenticated with your API key. - [Find an email with your AI assistant](/docs/leads/prospector/find-email/mcp): Ask Claude, ChatGPT or Cursor to find the email of a Prospector contact in plain English. - AI Scout - [AI Scout](/docs/leads/ai-scout): Describe who to find; a scout reads Google, YouTube and review sites every day and adds the people who fit as leads. - [AI Scout from your code](/docs/leads/ai-scout/api): REST endpoints for AI Scout: plan, create, run, pause and cap your scouts, authenticated with your API key. - [AI Scout with your AI assistant](/docs/leads/ai-scout/mcp): Ask Claude, ChatGPT or Cursor to set up, check or pause your AI Scouts in plain English. - **Organise & export** - Lists - [Lists](/docs/leads/lists): Keep people and companies in lists for campaigns and exports, or upload your own from a CSV. - [Lists from your code](/docs/leads/lists/api): REST endpoints for lists, authenticated with your API key. - [Lists with your AI assistant](/docs/leads/lists/mcp): Ask Claude, ChatGPT or Cursor about lists in plain English. - CSV Exports - [CSV Exports](/docs/leads/csv-export): Download your leads as a CSV: choose the sources and exactly which fields go in the file. - [Export leads to CSV from your code](/docs/leads/csv-export/api): REST endpoint to queue a CSV export of your leads for a date range, authenticated with your API key. - [Export leads to CSV with your AI assistant](/docs/leads/csv-export/mcp): Ask Claude, ChatGPT or Cursor to export your leads to a CSV in plain English. - Saved views - [Saved views](/docs/leads/saved-filters): Save a set of filters as a view and open it again in one click. - [Saved views from your code](/docs/leads/saved-filters/api): REST endpoints for saved views, authenticated with your API key. - [Saved views with your AI assistant](/docs/leads/saved-filters/mcp): Ask Claude, ChatGPT or Cursor about saved views in plain English. - Tag leads - [Tag leads](/docs/leads/tags): Group leads with your own tags, then filter by them or use them in automations. - [Tag leads from your code](/docs/leads/tags/api): REST endpoints to create tags and put them on leads, authenticated with your API key. - [Tag leads with your AI assistant](/docs/leads/tags/mcp): Ask Claude, ChatGPT or Cursor to tag your leads in plain English. - **Working with a lead** - Lead details - [Lead details](/docs/leads/lead-details): Open one lead to see the person, their company, how well they fit and an AI summary of their visits. - [Lead details from your code](/docs/leads/lead-details/api): REST endpoints for lead details, authenticated with your API key. - [Lead details with your AI assistant](/docs/leads/lead-details/mcp): Ask Claude, ChatGPT or Cursor about one lead in plain English: who they are, what they looked at and who else works there. - Notes on leads - [Notes on leads](/docs/leads/comments): Write notes on a lead that your whole team can see. - [Notes on leads from your code](/docs/leads/comments/api): REST endpoints for notes on leads, authenticated with your API key. - [Notes on leads with your AI assistant](/docs/leads/comments/mcp): Ask Claude, ChatGPT or Cursor to read or add team notes on a lead in plain English. - Session recordings - [Session recordings](/docs/leads/session-recordings): Replay what a lead did on your website, page by page. - [Session recordings from your code](/docs/leads/session-recordings/api): REST endpoints for session recordings, authenticated with your API key. - [Session recordings with your AI assistant](/docs/leads/session-recordings/mcp): Ask Claude, ChatGPT or Cursor for a lead's session recordings, a link to watch one, or to switch recording on, in plain English. - Company enrichment - [Company enrichment](/docs/leads/company-enrichment): Look a company up from its domain: its profile from the API, and the people who work there from your AI assistant. - [Company enrichment from your code](/docs/leads/company-enrichment/api): REST endpoint that returns a company's profile from its domain, authenticated with your API key. - [Company enrichment with your AI assistant](/docs/leads/company-enrichment/mcp): Ask Claude, ChatGPT or Cursor who works at a company, from its domain, in plain English. - Remove or block leads - [Remove or block leads](/docs/leads/hide-delete): Remove leads you do not want, or keep a company or person out of your automations. - [Remove or block leads from your code](/docs/leads/hide-delete/api): REST endpoints to hide, unhide or permanently delete leads, authenticated with your API key. - [Remove or block leads with your AI assistant](/docs/leads/hide-delete/mcp): Ask Claude, ChatGPT or Cursor to hide, unhide or delete leads in plain English. - Qualify - [Qualify](/docs/qualify): Score every lead against your ideal customer profile, so the right people rise to the top and the rest are left out. - Scoring models - [Scoring models](/docs/qualify/scoring-models): Score every new lead against your ideal customer with rules for company, location, pages visited and more. - [Scoring models from your code](/docs/qualify/scoring-models/api): REST endpoints for scoring models, authenticated with your API key. - [Scoring models with your AI assistant](/docs/qualify/scoring-models/mcp): Ask Claude, ChatGPT or Cursor about scoring models in plain English. - AI Assist - [AI Assist](/docs/qualify/ai-assist): Describe your business and who you sell to; AI proposes the scoring rules. - [AI Assist from your code](/docs/qualify/ai-assist/api): REST endpoints for ai assist, authenticated with your API key. - [AI Assist with your AI assistant](/docs/qualify/ai-assist/mcp): Ask Claude, ChatGPT or Cursor about ai assist in plain English. - Re-qualify existing leads - [Re-qualify existing leads](/docs/qualify/requalify): Score the leads you already have again after changing a model. - [Re-qualify existing leads from your code](/docs/qualify/requalify/api): REST endpoints for re-qualify existing leads, authenticated with your API key. - [Re-qualify existing leads with your AI assistant](/docs/qualify/requalify/mcp): Ask Claude, ChatGPT or Cursor about re-qualify existing leads in plain English. - Ideal customer profile - [Ideal customer profile](/docs/qualify/icp): Your ideal customer in one place: industries, company size, revenue, locations and the domains or industries to leave out. - [Ideal customer profile from your code](/docs/qualify/icp/api): REST endpoints for ideal customer profile, authenticated with your API key. - [Ideal customer profile with your AI assistant](/docs/qualify/icp/mcp): Ask Claude, ChatGPT or Cursor about ideal customer profile in plain English. - Exclude leads - [Exclude leads](/docs/qualify/exclusions): Keep companies, domains, countries, industries, job titles or pages out of your leads, and addresses out of your campaigns. - [Exclude leads from your code](/docs/qualify/exclusions/api): REST endpoints for exclude leads, authenticated with your API key. - [Exclude leads with your AI assistant](/docs/qualify/exclusions/mcp): Ask Claude, ChatGPT or Cursor about exclude leads in plain English. - Engage - [Engage](/docs/engage): Reach your leads with email and LinkedIn campaigns, and answer every reply in one inbox. - Email campaigns - [Email campaigns](/docs/engage/email-campaigns): Send email sequences to your leads from your own mailboxes, on the days and hours you choose. - [Email campaigns from your code](/docs/engage/email-campaigns/api): REST endpoints for email campaigns, authenticated with your API key. - [Email campaigns with your AI assistant](/docs/engage/email-campaigns/mcp): Ask Claude, ChatGPT or Cursor about email campaigns in plain English. - Sequences - [Sequences](/docs/engage/sequences): The emails of a campaign: what each one says, when it is sent and in what order. - [Sequences from your code](/docs/engage/sequences/api): REST endpoints for sequences, authenticated with your API key. - [Sequences with your AI assistant](/docs/engage/sequences/mcp): Ask Claude, ChatGPT or Cursor about sequences in plain English. - Campaign contacts - [Campaign contacts](/docs/engage/campaign-contacts): Add people to a campaign, see where each one is, and stop it for anyone who replied elsewhere. - [Campaign contacts from your code](/docs/engage/campaign-contacts/api): REST endpoints for campaign contacts, authenticated with your API key. - [Campaign contacts with your AI assistant](/docs/engage/campaign-contacts/mcp): Ask Claude, ChatGPT or Cursor about campaign contacts in plain English. - Campaign health - [Campaign health](/docs/engage/campaign-health): See how many emails a campaign can send a day and what holds it back. - [Campaign health from your code](/docs/engage/campaign-health/api): REST endpoints for campaign health, authenticated with your API key. - [Campaign health with your AI assistant](/docs/engage/campaign-health/mcp): Ask Claude, ChatGPT or Cursor about campaign health in plain English. - Master Inbox - [Master Inbox](/docs/engage/master-inbox): Every reply to every campaign, from all your mailboxes, in one inbox. - [Master Inbox from your code](/docs/engage/master-inbox/api): REST endpoints for the Master Inbox, authenticated with your API key. - [Master Inbox with your AI assistant](/docs/engage/master-inbox/mcp): Ask Claude, ChatGPT or Cursor about the Master Inbox in plain English. - LinkedIn campaigns - [LinkedIn campaigns](/docs/engage/linkedin-campaigns): Send connection requests, with an optional personalised note, from your LinkedIn account. - [LinkedIn campaigns from your code](/docs/engage/linkedin-campaigns/api): REST endpoints for LinkedIn campaigns, authenticated with your API key. - [LinkedIn campaigns with your AI assistant](/docs/engage/linkedin-campaigns/mcp): Ask Claude, ChatGPT or Cursor about LinkedIn campaigns in plain English. - LinkedIn Chrome extension - [LinkedIn Chrome extension](/docs/engage/linkedin-extension): Install the Happierleads LinkedIn extension so your LinkedIn campaigns send connection requests from your own browser. - Ads audiences - [Ads audiences](/docs/engage/ads-audiences): Show ads to the people who visited your website: send them to Google, LinkedIn and Meta Ads as audiences. - [Ads audiences from your code](/docs/engage/ads-audiences/api): Google Ads retargeting audiences built from your leads, authenticated with your API key. - [Ads audiences with your AI assistant](/docs/engage/ads-audiences/mcp): Ask Claude, ChatGPT or Cursor about your ad audiences in plain English. - Mailboxes & domains - Email accounts - [Email accounts](/docs/engage/mailboxes/email-accounts): Connect the mailboxes your campaigns send from: Gmail, Outlook or any SMTP/IMAP mailbox. - [Email accounts from your code](/docs/engage/mailboxes/email-accounts/api): REST endpoints for email accounts, authenticated with your API key. - [Email accounts with your AI assistant](/docs/engage/mailboxes/email-accounts/mcp): Ask Claude, ChatGPT or Cursor about email accounts in plain English. - Warmup - [Warmup](/docs/engage/mailboxes/warmup): Warm up new mailboxes so their emails land in the inbox, not in spam. - [Warmup from your code](/docs/engage/mailboxes/warmup/api): REST endpoints for warmup, authenticated with your API key. - [Warmup with your AI assistant](/docs/engage/mailboxes/warmup/mcp): Ask Claude, ChatGPT or Cursor about warmup in plain English. - Deliverability check - [Deliverability check](/docs/engage/mailboxes/deliverability): Check a mailbox’s SPF, DKIM, DMARC and tracking domain so its emails are trusted. - [Deliverability check from your code](/docs/engage/mailboxes/deliverability/api): REST endpoints for deliverability check, authenticated with your API key. - [Deliverability check with your AI assistant](/docs/engage/mailboxes/deliverability/mcp): Ask Claude, ChatGPT or Cursor about deliverability check in plain English. - Outreach domains - [Outreach domains](/docs/engage/mailboxes/domains): Separate domains for your sending mailboxes, so outreach never risks your main domain. - [Outreach domains from your code](/docs/engage/mailboxes/domains/api): REST endpoints for outreach domains, authenticated with your API key. - [Outreach domains with your AI assistant](/docs/engage/mailboxes/domains/mcp): Ask Claude, ChatGPT or Cursor about outreach domains in plain English. - Automations - [Overview](/docs/automations): Send the right leads to Slack, your CRM, a webhook or your inbox the moment they arrive. - Build an automation - [Build an automation](/docs/automations/automations): Act on new leads the moment they arrive: post to Slack, push to your CRM, start a campaign, call a webhook or email an alert. - [Automations from your code](/docs/automations/automations/api): REST endpoints for automations, authenticated with your API key. - [Automations with your AI assistant](/docs/automations/automations/mcp): Ask Claude, ChatGPT or Cursor about automations in plain English. - **Send leads to** - Slack - [Slack](/docs/automations/slack): Post every new lead to a Slack channel, with the message you choose. - [Slack from your code](/docs/automations/slack/api): REST endpoints for slack, authenticated with your API key. - [Slack with your AI assistant](/docs/automations/slack/mcp): Ask Claude, ChatGPT or Cursor about slack in plain English. - Webhooks - [Webhooks](/docs/automations/webhook): Send every new lead as JSON to a URL of your own: your app, Make, n8n or any tool that takes a webhook. - [Webhooks from your code](/docs/automations/webhook/api): REST endpoints for webhooks, authenticated with your API key. - [Webhooks with your AI assistant](/docs/automations/webhook/mcp): Ask Claude, ChatGPT or Cursor about webhooks in plain English. - Clay - [Clay](/docs/automations/clay): Send new leads to a Clay table to enrich and route them. - [Clay from your code](/docs/automations/clay/api): REST endpoints for clay, authenticated with your API key. - [Clay with your AI assistant](/docs/automations/clay/mcp): Ask Claude, ChatGPT or Cursor about clay in plain English. - Email campaigns - [Email campaigns](/docs/automations/email-campaigns): Add every matching lead to an email campaign automatically. - [Email campaigns from your code](/docs/automations/email-campaigns/api): REST endpoints for email campaigns, authenticated with your API key. - [Email campaigns with your AI assistant](/docs/automations/email-campaigns/mcp): Ask Claude, ChatGPT or Cursor about email campaigns in plain English. - Push leads to your CRM - Connect & map fields - [Connect & map fields](/docs/automations/crm/overview): Connect HubSpot, Pipedrive, Zoho, Salesforce or GoHighLevel, map the fields, and let an automation send the leads that match. - [Push leads to your CRM from your code](/docs/automations/crm/overview/api): REST endpoints for push leads to your crm, authenticated with your API key. - [Push leads to your CRM with your AI assistant](/docs/automations/crm/overview/mcp): Ask Claude, ChatGPT or Cursor about push leads to your crm in plain English. - HubSpot - [HubSpot](/docs/automations/crm/hubspot): Push leads to HubSpot as contacts linked to their company, owned by the person you pick, and optionally a deal for each. - [HubSpot from your code](/docs/automations/crm/hubspot/api): REST endpoints for hubspot, authenticated with your API key. - [HubSpot with your AI assistant](/docs/automations/crm/hubspot/mcp): Ask Claude, ChatGPT or Cursor about hubspot in plain English. - Salesforce - [Salesforce](/docs/automations/crm/salesforce): Push leads to Salesforce: create a lead in Salesforce for each matching visitor, assigned to an owner you pick. - [Salesforce from your code](/docs/automations/crm/salesforce/api): REST endpoints for salesforce, authenticated with your API key. - [Salesforce with your AI assistant](/docs/automations/crm/salesforce/mcp): Ask Claude, ChatGPT or Cursor about salesforce in plain English. - Pipedrive - [Pipedrive](/docs/automations/crm/pipedrive): Push leads to Pipedrive: create a person and organisation in Pipedrive, assigned to an owner you pick. - [Pipedrive from your code](/docs/automations/crm/pipedrive/api): REST endpoints for pipedrive, authenticated with your API key. - [Pipedrive with your AI assistant](/docs/automations/crm/pipedrive/mcp): Ask Claude, ChatGPT or Cursor about pipedrive in plain English. - Zoho CRM - [Zoho CRM](/docs/automations/crm/zoho): Push leads to Zoho CRM: create a lead in Zoho CRM, assigned to an owner you pick. - [Zoho CRM from your code](/docs/automations/crm/zoho/api): REST endpoints for zoho crm, authenticated with your API key. - [Zoho CRM with your AI assistant](/docs/automations/crm/zoho/mcp): Ask Claude, ChatGPT or Cursor about zoho crm in plain English. - GoHighLevel - [GoHighLevel](/docs/automations/crm/gohighlevel): Push leads to GoHighLevel: create a contact in GoHighLevel, optionally an opportunity in a pipeline stage, with tags. - [GoHighLevel from your code](/docs/automations/crm/gohighlevel/api): REST endpoints for gohighlevel, authenticated with your API key. - [GoHighLevel with your AI assistant](/docs/automations/crm/gohighlevel/mcp): Ask Claude, ChatGPT or Cursor about gohighlevel in plain English. - **Check** - Run history & re-run - [Run history & re-run](/docs/automations/run-history): See what each automation did with each lead, and run it again once a failure is fixed. - [Run history & re-run from your code](/docs/automations/run-history/api): REST endpoints for run history & re-run, authenticated with your API key. - [Run history & re-run with your AI assistant](/docs/automations/run-history/mcp): Ask Claude, ChatGPT or Cursor about run history & re-run in plain English. - Websites & tracking - [Websites & tracking](/docs/websites): Add your websites, install the tracking pixel and see how they perform. - Websites - [Websites](/docs/websites/websites): Add, edit and remove the websites you track, and share your plan's leads between them. - [Websites from your code](/docs/websites/websites/api): REST endpoints for websites, authenticated with your API key. - [Websites with your AI assistant](/docs/websites/websites/mcp): Ask Claude, ChatGPT or Cursor to list, add, change or remove your websites in plain English. - Install the tracking pixel - [Install the tracking pixel](/docs/websites/tracking-pixel): Install the pixel with Google Tag Manager, WordPress or a snippet of HTML, then check it works. - [Install the tracking pixel from your code](/docs/websites/tracking-pixel/api): REST endpoints to fetch a website's pixel code, check that it is installed and set account-wide tracking, authenticated with your API key. - [Install the tracking pixel with your AI assistant](/docs/websites/tracking-pixel/mcp): Ask Claude, ChatGPT or Cursor for your pixel code, to check it is installed, or why a website gets no leads. - Website analytics - [Website analytics](/docs/websites/analytics): Visits, identified leads, ICP match rate and who your visitors are, per website. - [Website analytics from your code](/docs/websites/analytics/api): REST endpoints for website analytics, authenticated with your API key. - [Website analytics with your AI assistant](/docs/websites/analytics/mcp): Ask Claude, ChatGPT or Cursor how a website is doing, who its leads are, and why it gets no leads. - Team & account - [Team & account](/docs/account): Your team, your plan and credits, your keys and your settings. - Team members - [Team members](/docs/account/team): Invite people and choose what they can do and which websites they see. - [Team members from your code](/docs/account/team/api): REST endpoints for team members, authenticated with your API key. - [Team members with your AI assistant](/docs/account/team/mcp): Ask Claude, ChatGPT or Cursor about team members in plain English. - Plan, billing & credits - [Plan, billing & credits](/docs/account/billing): Your plan, who can manage it, invoices and how credits are used. - [Billing from your code](/docs/account/billing/api): Credits, credit history, invoices, sending domains and auto top-up from your code, with your API key. - [Plan, billing & credits with your AI assistant](/docs/account/billing/mcp): Ask Claude, ChatGPT or Cursor about plan, billing & credits in plain English. - Cancel or pause your plan - [Cancel or pause your plan](/docs/account/cancel-or-pause): Cancel, pause, unpause or restart your subscription. - Trials, offers and lifetime deal codes - [Trials, offers and lifetime deal codes](/docs/account/trials-and-codes): What a free account and a trial include, the 2X trial bonus, offer codes and lifetime deal codes. - Account settings & sign-in - [Account settings & sign-in](/docs/account/settings): Your profile, password, notifications, compliance (GDPR & DPA), and signing in. - Partner programs - [Partner programs](/docs/account/partners): Community, the Affiliate Program, the Creator Program and the Agency Creator Program. - **Partners & white label** - Embed Happierleads screens - [Introduction](/docs/embed): Show our Leads, pixel install and other screens inside your own app, under your brand, in an iframe. - [Quickstart: your first embedded screen](/docs/embed/quickstart): In about 10 minutes, see one of your own websites inside a local page, before writing any real integration. - **Understand** - [How it works](/docs/embed/how-it-works): Who talks to whom, the three flows (setup, sign-up, log-in) and what happens without you. - [Start here: one-time setup](/docs/embed/one-time-setup): Once, before your first client: your domain, embedding switched on with your keys, and a website for every client you already have. - [Scenario 1: a client signs up](/docs/embed/client-signs-up): A new client fills in your sign-up form: your server creates their website and trial, then their first page opens the install screen. - [Scenario 2: a client logs in](/docs/embed/client-logs-in): A client who already has a website signs in: nothing is created, your server asks for a one-time link and their leads open. - **Build it, step by step** - [Your domain and keys](/docs/embed/setup): Put the screens on your own domain, switch embedding on and create the two keys your server uses. - [Choose what your users see](/docs/embed/what-users-see): Which Leads tabs, parts of the Leads screen and extra screens your users get, and how long a screen stays open. - [Create a website when a client signs up](/docs/embed/create-website): In your sign-up code: one website per client, its id saved on your customer. - [Open a screen: the one-time link](/docs/embed/open-a-screen): One endpoint on your server asks for a link every time your page shows an embedded screen. - [Show it in an iframe](/docs/embed/iframe): Put the one-time link in an iframe, listen to the frame's messages and refresh when a session ends. - **Billing: leads follow payment** - [Start a trial](/docs/embed/start-trial): A new client gets a number of leads until an end date: two calls from your sign-up code. - [Switch to paid](/docs/embed/switch-to-paid): A client pays: paid mode with a monthly refill date, then the plan's leads, refilled now. - [Change plan or billing date](/docs/embed/change-plan): Upgrades, downgrades and a moved billing date. A normal monthly renewal needs no call. - [Cancel or unpaid](/docs/embed/cancel): No more leads and no more refills; their data is kept for when they come back. - **Go live** - [Bring your existing clients across](/docs/embed/existing-clients): A one-off script, run before launch, that gives every client you already have a website. - [Security: server vs browser](/docs/embed/security): Which keys and calls stay on your server, what is safe in the browser, and what to never do. - [Build it with your AI coding assistant](/docs/embed/build-with-ai): A ready prompt for Claude, Cursor or any AI coding assistant that builds every step of this section, with a checklist so nothing is forgotten. - Full white label - [Introduction](/docs/white-label): Your clients use the whole Happierleads dashboard on your own domain, with your brand. You sell it and bill it. - [Your domain, brand and assets](/docs/white-label/setup): The White label wizard: two addresses of yours, the DNS records, your brand and your logos. - [Add a client](/docs/white-label/add-a-client): When a client signs up on your site: create their website, then invite them to sign in on your domain. - [Start a trial](/docs/white-label/start-trial): A new client gets a number of leads until an end date: two calls from your sign-up code. - [Switch to paid](/docs/white-label/switch-to-paid): A client pays: paid mode with a monthly refill date, then the plan's leads, refilled now. - [Change plan or billing date](/docs/white-label/change-plan): Upgrades, downgrades and a moved billing date. A normal monthly renewal needs no call. - [Cancel or unpaid](/docs/white-label/cancel): No more leads and no more refills; their data is kept for when they come back. - [Build it with your AI coding assistant](/docs/white-label/build-with-ai): A ready prompt that connects your sign-up and billing to Happierleads for a full white label. - **AI & developers** - MCP server - [Connect your AI assistant](/docs/mcp): Connect Claude, ChatGPT, Cursor or any MCP client to Happierleads in about two minutes, then ask for what you need in plain English. - [Security and permissions](/docs/mcp/security): What an AI assistant can see and change in your Happierleads account, and how to stay in control. - [Errors and troubleshooting](/docs/mcp/errors): What goes wrong when using Happierleads through an AI assistant, and how the assistant and you recover. - Free tools - [Free tools](/docs/mcp/free-tools): Free tools any AI assistant can use with a free Happierleads account: company enrichment, decision makers, lookalikes and more. - [free_enrich_company](/docs/mcp/free-tools/free-enrich-company): Free on every plan of a signed-in account, also after the trial ends, no credits used. - [free_intent_signals](/docs/mcp/free-tools/free-intent-signals): Free on every plan of a signed-in account, also after the trial ends, no credits used. - [free_find_decision_makers](/docs/mcp/free-tools/free-find-decision-makers): Free on every plan of a signed-in account, also after the trial ends, no credits used. - [free_companies_using_tech](/docs/mcp/free-tools/free-companies-using-tech): Free on every plan of a signed-in account, also after the trial ends, no credits used. - [free_find_lookalikes](/docs/mcp/free-tools/free-find-lookalikes): Free on every plan of a signed-in account, also after the trial ends, no credits used. - [free_people_search](/docs/mcp/free-tools/free-people-search): Free on every plan of a signed-in account, also after the trial ends, no credits used. - [free_email_pattern](/docs/mcp/free-tools/free-email-pattern): Free on every plan of a signed-in account, also after the trial ends, no credits used. - [All tools](/docs/mcp/tools): Every tool the Happierleads MCP server gives your AI assistant, grouped by product area. - **Account & billing** - [get_account](/docs/mcp/tools/get-account): Shows the signed-in account: plan, credit limits and remaining credits, refresh and trial dates, add-ons, features, settings, pause status, failed-payment flag and the account's websites (the first 11 only). - [update_account_tracking_settings](/docs/mcp/tools/update-account-tracking-settings): Turns tracking options on or off for every website of the account at once: identify people, suggested contacts, personal emails, session recordings. - [get_credit_summary](/docs/mcp/tools/get-credit-summary): Credits used in a billing cycle, by source (website visitors, Prospector, AI Scout, Web Scraping…) and by day (byDay: charges, refunds and duplicates prevented per date, UTC), with the plan limit, what is left and leads bought. - [list_billing_domains](/docs/mcp/tools/list-billing-domains): The account's sending domains with their billing: price and renewalPrice (USD a year), expiresAt (renewal date), autoRenew and cancelAtPeriodEnd, setupCompleted and activeDate. - [list_open_invoices](/docs/mcp/tools/list-open-invoices): The account invoices that are still unpaid (open or past due): amount, currency, due date, what it is for, the payment status, the PDF link and hosted (the page where it can be paid); at most 5, newest first; plus the next upcoming invoice (amount and the date the period ends), or null on a cancelled or lifetime plan. - [list_invoices](/docs/mcp/tools/list-invoices): The account's invoices, newest first: date, amount, refunded amount, currency, status (paid, open, void, uncollectible, refunded, partially_refunded), description (what it was for), a link to the PDF and hosted (the invoice's web page, where an open one can be paid). - [get_auto_topup](/docs/mcp/tools/get-auto-topup): Whether auto top-up is on: when credits run out, a pack of leads is bought automatically at your plan's price per lead, up to a monthly cap in USD. - [set_auto_topup](/docs/mcp/tools/set-auto-topup): Turns auto top-up on or off and sets the pack of leads bought each time credits run out and the monthly cap in USD. - [get_billing](/docs/mcp/tools/get-billing): Returns the same subscription summary as get_subscription: plan, leads per month, credits used and remaining, top-up credits, price, billing interval, next billing date, whether it is set to cancel or is paused, pending downgrade and any running retention discount. - [get_pricing](/docs/mcp/tools/get-pricing): Returns the account's prices for outreach mailboxes and sending domains: mailboxPricePerMonthUSD (and the yearly equivalent), whether custom or default pricing applies, the defaults, and the outreach starter-kit state (available now, or earned on upgrade). - [get_credit_history](/docs/mcp/tools/get-credit-history): Lists the account's credit transactions from the last 90 days, newest first: each row has operation (CHARGE, REFUND or DUPLICATE_PREVENTED), amount, credits before/after, the website, the lead's domain/email, a source category (WEBSITE_VISITOR, INTENT_SIGNALS, WEB_SCRAPING, PROSPECTOR, ENRICHMENT, EMAIL_VERIFICATION, CONTACT_UNLOCK, ADJUSTMENT, OTHER), a reason and createdAt. - [get_website_credit_history](/docs/mcp/tools/get-website-credit-history): Returns the credit snapshots stored for one website: each entry has creditsLimit, creditsRemaining, creditsUsed, refreshOn and timestamps. - [get_subscription](/docs/mcp/tools/get-subscription): Shows the current subscription: plan, tierName, leads per month, usedCredits, remaining, topUpCredits, refreshOn, price (monthly equivalent, USD), annualTotal, interval ('month' or 'year'), nextBillingDate, cancelAtPeriodEnd, subscriptionStatus, isPausedByUser/pausedUntil, pendingDowngrade, retentionDiscount and add-ons. - [preview_plan_change](/docs/mcp/tools/preview-plan-change): Shows what a plan change would cost without changing anything. - [upgrade_plan](/docs/mcp/tools/upgrade-plan): Moves the subscription to more leads per month right away and charges the card on file today. - [downgrade_plan](/docs/mcp/tools/downgrade-plan): Schedules the subscription to change to a new number of leads per month from the next billing date; nothing is charged or refunded now and current credits stay until then. - [pause_subscription](/docs/mcp/tools/pause-subscription): Pauses the subscription for 1 to 6 months: invoices during the pause are not collected, no new leads come in while paused, and it resumes automatically on pausedUntil. - [cancel_subscription](/docs/mcp/tools/cancel-subscription): Cancels the subscription at the end of the current billing period (it stays usable until then) and records why. - [reactivate_subscription](/docs/mcp/tools/reactivate-subscription): Undoes a cancellation that has not taken effect yet, or ends a pause early. - **Team** - [list_members](/docs/mcp/tools/list-members): Lists the people on the account as team: userId, name, email, role (Owner or Member), permissions, preset, allWebsites, websites (website ids, empty when allWebsites is true) and whether their invite is still pending (invitePending). - [get_permissions_catalog](/docs/mcp/tools/get-permissions-catalog): Returns every permission a member can be given and the presets (full, sales, developer, viewer, team, client) with the permissions each one ticks. - [invite_members](/docs/mcp/tools/invite-members): Invites people to the account; each one gets an invitation email to set a password (emailed: false when invite emails are off, then they copy the join link from the Team page). - [update_member](/docs/mcp/tools/update-member): Changes a member's role, permissions or websites and returns the member as list_members does. - [remove_member](/docs/mcp/tools/remove-member): Removes a person from the account: they lose access straight away, their website access is removed and the invitation is given back. - **Prospector** - [create_contact](/docs/mcp/tools/create-contact): Saves a new person record (name, job title, company domain) and returns it with its _id. - [verify_contact](/docs/mcp/tools/verify-contact): Checks whether the email of a saved contact is valid and deliverable. - [search_companies](/docs/mcp/tools/search-companies): Searches the company database by name or domain keyword, industry, HQ country, headcount, revenue and technologies. - [search_people](/docs/mcp/tools/search-people): Searches the 209M-contact people database by job title, company, company HQ country, seniority, department, industry, technology and company size. - [reveal_contact](/docs/mcp/tools/reveal-contact): Returns the email address and phone number held for one person from search_people. - [find_contact_email](/docs/mcp/tools/find-contact-email): Looks for a business email for one search_people contact by trying likely address patterns at their company and verifying each one. - [list_auto_searches](/docs/mcp/tools/list-auto-searches): Lists the Auto Searches of one website: name, status (running or paused), preferences, people per day, leads delivered today and in total, the matching pool and the last run. - [build_auto_search_profile](/docs/mcp/tools/build-auto-search-profile): Turns a plain-English description of the ideal customer ("founders of US SaaS companies with 10-200 staff") into Auto Search preferences: field, values and weight (Must, High, Prefer or Bonus). - [create_auto_search](/docs/mcp/tools/create-auto-search): Creates an Auto Search and starts it: every day new people matching the preferences are verified and added to the website's leads, 1 credit per lead delivered, up to perDay a day, until it is paused. - [pause_auto_search](/docs/mcp/tools/pause-auto-search): Pauses one Auto Search: no more leads are delivered and no more credits are used until it is resumed. - [resume_auto_search](/docs/mcp/tools/resume-auto-search): Resumes a paused Auto Search: deliveries start again today, 1 credit per lead delivered. - [get_icp](/docs/mcp/tools/get-icp): Returns the ideal customer profile (ICP) saved for a website: the companies the user wants to reach. - [update_icp](/docs/mcp/tools/update-icp): Changes a website's ideal customer profile: target industries, sectors, HQ locations, headcount and revenue ranges. - **Qualify (lead scoring)** - [recalculate_lead_scores](/docs/mcp/tools/recalculate-lead-scores): Re-run lead scoring for specific leads against the website's current scoring models, and answer any AI qualification questions those leads do not have an answer for yet. - [list_lead_scoring_models](/docs/mcp/tools/list-lead-scoring-models): List a website's lead scoring models (Qualify): the rules that score each lead on company, people and behaviour criteria and mark it warm or hot. - [create_lead_scoring_model](/docs/mcp/tools/create-lead-scoring-model): Create a lead scoring model on a website, with its rules: criteria (same shape as get_lead_scoring_model / update_lead_scoring_model), active and aiMatching are saved with it. - [ai_generate_scoring_model](/docs/mcp/tools/ai-generate-scoring-model): Have AI build a lead scoring model from the website's own pages (it reads the site to infer the ideal customer) and save it as 'ICP Score - AI Generated'. - [get_lead_scoring_model](/docs/mcp/tools/get-lead-scoring-model): Get one lead scoring model with all its rules. - [update_lead_scoring_model](/docs/mcp/tools/update-lead-scoring-model): Change a lead scoring model's name, on/off state and/or rules. - [delete_lead_scoring_model](/docs/mcp/tools/delete-lead-scoring-model): Permanently delete a lead scoring model and remove its score from every lead of the website. - **Automations & CRM** - [get_lead_automation_history](/docs/mcp/tools/get-lead-automation-history): List every automation run recorded for one lead, newest first, as automationLogs[] with status, message (the result or error text), automation (the automation id, see list_automations) and executedAt. - [retrigger_automations](/docs/mcp/tools/retrigger-automations): Runs a website's automations again for a list of leads, for example after a CRM or Slack connection was fixed. - [list_crm_variables](/docs/mcp/tools/list-crm-variables): The lead and company fields (name, email, job title, company size, pages visited, score…) that can be mapped to fields in your CRM. - [get_crm_mappings](/docs/mcp/tools/get-crm-mappings): The field mappings used when leads are pushed to a CRM: which lead field fills which CRM field, for contacts and companies. - [set_crm_mappings](/docs/mcp/tools/set-crm-mappings): Sets the field mappings for contacts or companies pushed to a CRM. - [get_slack_message_template](/docs/mcp/tools/get-slack-message-template): The template of the message posted to Slack for each lead: template (null = the default is used), defaultTemplate and mergeFields (every field a template may use). - [set_slack_message_template](/docs/mcp/tools/set-slack-message-template): Changes the template of the message posted to Slack for each lead (Slack formatting: *bold*, _italic_). - [send_slack_test_message](/docs/mcp/tools/send-slack-test-message): Posts a sample lead message (marked [Test Notification]) to a Slack channel so you can see how it looks. - [test_webhook](/docs/mcp/tools/test-webhook): Sends a sample lead, as automations send them, to a URL so you can check your endpoint receives and parses it. - [preview_automation_filter](/docs/mcp/tools/preview-automation-filter): Counts the leads of the last days (days, default 7, at most 90) that match a saved filter, before you use it in an automation. - [get_automation_stats](/docs/mcp/tools/get-automation-stats): Last 7 days (UTC) for every automation of a website, keyed by automation id, each with its name and isActive: runs7d (leads it ran on), delivered7d (sent), failed7d (failed attempts), failedLeads7d (leads whose latest attempt still failed; retries that worked drop out), lastRunAt (last run within 90 days) and series (one row per day). - [get_automation_runs](/docs/mcp/tools/get-automation-runs): The runs of one automation, newest first: which lead each run handled, when, and whether it succeeded (and why not). - [list_slack_channels](/docs/mcp/tools/list-slack-channels): The channels of the Slack workspace connected to this website (archived ones left out), to pick one for a Slack automation: id, name, isPrivate, isMember (the app is in it) and members. - [list_automations](/docs/mcp/tools/list-automations): Lists a website's automations: rules that act when a lead matches, for example sending to Slack, a CRM, a webhook, Zapier, an email or LinkedIn campaign, or an email alert. - [create_automation](/docs/mcp/tools/create-automation): Creates an automation that is active straight away and runs whenever a lead matches it. - [get_automation](/docs/mcp/tools/get-automation): Returns the full setup of one automation: name, isActive, when (trigger event), then (action), trigger, interval, frequency settings (repeatWindowHours, dedupeScope), contact selection, email verification rules, filter and the action settings, plus draft (true = unfinished, never runs) and errorMessage (why the last run failed, null when fine). - [update_automation](/docs/mcp/tools/update-automation): Changes an existing automation: its name, rule, action settings or on/off state. - [delete_automation](/docs/mcp/tools/delete-automation): Deletes an automation permanently, so it no longer acts on any lead. - [toggle_automation](/docs/mcp/tools/toggle-automation): Switches an automation on or off without changing its setup. - [rerun_automation_for_lead](/docs/mcp/tools/rerun-automation-for-lead): Runs one type of automation again for a single lead right now and reports the outcome. - [push_lead_to_crm](/docs/mcp/tools/push-lead-to-crm): Creates a contact in the website's connected CRM: HubSpot, Pipedrive, Salesforce, Zoho or GoHighLevel. - [list_crm_owners](/docs/mcp/tools/list-crm-owners): Lists the users in a connected CRM that a contact can be assigned to. - [list_crm_pipelines](/docs/mcp/tools/list-crm-pipelines): Lists the deal pipelines of a connected CRM and the stages in each. - **Intent data** - [get_intent_topics_catalog](/docs/mcp/tools/get-intent-topics-catalog): Lists every third-party intent topic you can subscribe to, e.g. - [list_intent_topics](/docs/mcp/tools/list-intent-topics): Lists the intent topics a website is subscribed to, with delivery numbers. - [subscribe_to_intent_topic](/docs/mcp/tools/subscribe-to-intent-topic): Subscribes a website to an intent topic, so companies researching that topic start arriving as leads each day, up to the daily limit. - [update_intent_topic](/docs/mcp/tools/update-intent-topic): Pauses or resumes an intent topic subscription, or changes its daily lead limit. - [delete_intent_topic](/docs/mcp/tools/delete-intent-topic): Unsubscribes a website from an intent topic and deletes the subscription, including its delivery counters. - **Campaigns & inbox** - [list_email_blacklist](/docs/mcp/tools/list-email-blacklist): Lists the email addresses campaigns on this website never send to, grouped by the name they were added under. - [add_to_email_blacklist](/docs/mcp/tools/add-to-email-blacklist): Adds email addresses that campaigns on this website must never send to, e.g. - [remove_from_email_blacklist](/docs/mcp/tools/remove-from-email-blacklist): Removes every address added under one group name; campaigns can email them again. - [update_campaign](/docs/mcp/tools/update-campaign): Renames a campaign, starts it (status active: emails start going out to its contacts) or pauses it, or changes its sending days (0 Sunday to 6 Saturday), hours (timeSlot start and end, 0-24), timezone or open/click tracking. - [clone_campaign](/docs/mcp/tools/clone-campaign): Copies a campaign with its steps and settings, named ' (copy)'. - [get_campaign_stats](/docs/mcp/tools/get-campaign-stats): Returns how a campaign is doing: emails sent, opened, clicked, replied, bounced and unsubscribed, with rates. - [get_campaign_capacity](/docs/mcp/tools/get-campaign-capacity): Returns the campaign's health: connected mailboxes and their daily limits, how many emails it can send a day, and what is holding it back (e.g. - [add_campaign_step](/docs/mcp/tools/add-campaign-step): Adds one email at the end of a campaign's sequence, sent delayDays after the previous one (the first step of an empty campaign becomes the opening email). - [delete_campaign_step](/docs/mcp/tools/delete-campaign-step): Removes one email from a campaign's sequence for good. - [reorder_campaign_steps](/docs/mcp/tools/reorder-campaign-steps): Puts a campaign's emails in a new order. - [resume_prospects](/docs/mcp/tools/resume-prospects): Resumes paused prospects so their emails are sent again from their next scheduled step. - [send_prospects_now](/docs/mcp/tools/send-prospects-now): Sends the next email of their sequence to the given prospects right away instead of at their scheduled time, within the mailbox limits. - [change_prospects_mailbox](/docs/mcp/tools/change-prospects-mailbox): Moves prospects to another mailbox: their next emails are sent from it. - [reschedule_prospects](/docs/mcp/tools/reschedule-prospects): Recalculates when the next email of each prospect goes out, spread over the coming days within the mailbox limits, e.g. - [generate_campaign_emails_ai](/docs/mcp/tools/generate-campaign-emails-ai): Writes a sequence of emails for a campaign with AI, from your website, offer and ideal customer, and saves them as the campaign steps. - [list_linkedin_keywords](/docs/mcp/tools/list-linkedin-keywords): The keywords watched on LinkedIn (LinkedIn Fans): people who post or comment about them become leads. - [add_linkedin_keyword](/docs/mcp/tools/add-linkedin-keyword): Starts watching a keyword on LinkedIn: people who post or comment about it become leads. - [set_linkedin_keyword_status](/docs/mcp/tools/set-linkedin-keyword-status): Pauses or resumes watching one LinkedIn keyword. - [delete_linkedin_keyword](/docs/mcp/tools/delete-linkedin-keyword): Stops watching a LinkedIn keyword for good and removes it from the list. - [list_linkedin_tracked_posts](/docs/mcp/tools/list-linkedin-tracked-posts): The LinkedIn posts being tracked: people who react to or comment on them become leads. - [add_linkedin_tracked_post](/docs/mcp/tools/add-linkedin-tracked-post): Starts tracking a LinkedIn post (yours or someone else’s): people who react to or comment on it become leads. - [update_linkedin_account](/docs/mcp/tools/update-linkedin-account): Changes the label of a connected LinkedIn account, or pauses and resumes it (paused: its campaigns send nothing). - [list_google_ads_audiences](/docs/mcp/tools/list-google-ads-audiences): The Google Ads retargeting audiences of a website: name, linked Google campaign, contacts uploaded and match stats. - [get_google_ads_audience](/docs/mcp/tools/get-google-ads-audience): One retargeting audience: settings, contacts uploaded, match rate and the stats of its Google campaign. - [sync_google_ads_audience_stats](/docs/mcp/tools/sync-google-ads-audience-stats): Fetches the latest impressions, clicks and conversions of an audience’s campaign from Google Ads. - [dismiss_campaign_capacity_warning](/docs/mcp/tools/dismiss-campaign-capacity-warning): Hides a campaign's capacity warning (more contacts than its mailboxes can send to in time) for some days. - [spam_check_email](/docs/mcp/tools/spam-check-email): Checks an email subject and body for words and patterns that send mail to spam, and returns a score with each issue and how to fix it. - [get_linkedin_campaign](/docs/mcp/tools/get-linkedin-campaign): One LinkedIn campaign of this website: its settings and the people in it with their status (invited, connected, messaged, replied), optionally one status, page by page. - [get_linkedin_campaign_timeline](/docs/mcp/tools/get-linkedin-campaign-timeline): What a LinkedIn campaign did day by day over the last days: invitations sent, accepted, messages sent and replies. - [activate_linkedin_campaign](/docs/mcp/tools/activate-linkedin-campaign): Starts a LinkedIn campaign: it begins sending invitations and messages from the connected LinkedIn account, within the account's daily LinkedIn limits. - [pause_linkedin_campaign](/docs/mcp/tools/pause-linkedin-campaign): Pauses a running LinkedIn campaign: nothing more is sent until it is resumed. - [resume_linkedin_campaign](/docs/mcp/tools/resume-linkedin-campaign): Resumes a paused LinkedIn campaign: it continues sending invitations and messages where it stopped. - [delete_linkedin_campaign](/docs/mcp/tools/delete-linkedin-campaign): Deletes a LinkedIn campaign and stops everything it would still send. - [get_email_template](/docs/mcp/tools/get-email-template): Returns one email (step) of a campaign in full: subject and body templates with their merge fields, the sender, the delay before it is sent and its position in the sequence. - [get_prospects](/docs/mcp/tools/get-prospects): List the contacts (prospects) already added to email campaigns on a website, newest first. - [list_campaigns](/docs/mcp/tools/list-campaigns): List the email campaigns of one website, newest first, with their status (isActive), schedule, steps (emailCampaignTemplates), health and a cached stats snapshot (statsRollup: contacted, sent, opens, clicks, replies, bounces and rates, refreshed about every 5 minutes; see computedAt). - [create_campaign](/docs/mcp/tools/create-campaign): Create a new email sequence: the campaign plus one email per entry in steps (the first is the initial email, the rest follow-ups). - [update_campaign_step](/docs/mcp/tools/update-campaign-step): Rewrite one email (step) of an existing campaign: its subject, body and/or delay. - [get_campaign](/docs/mcp/tools/get-campaign): Get one email campaign with live analytics: settings (isActive, schedule, timezone), its steps in emailCampaignTemplates[] (each with _id = templateId for update_campaign_step, subject, body and per-step stats), stats (prospect total, scheduledCount, uniqueContacted, totalEmailsSent, opens, clicks, replies, warm replies, bounced, unsubscribed and their rates), steps[] (per-step sent/opened/clicked/replied), statusBuckets (prospect counts per status) and statistics (sent vs scheduled over time). - [add_prospect_to_campaign](/docs/mcp/tools/add-prospect-to-campaign): Add one contact to an existing email campaign so it receives the sequence, like Manual Entry in the app. - [remove_prospect_from_campaign](/docs/mcp/tools/remove-prospect-from-campaign): Delete a prospect from its campaign, like "Remove from campaign" in the app: the prospect and its scheduled emails are deleted, emails already sent stay sent, and its history is gone. - [stop_prospect](/docs/mcp/tools/stop-prospect): Stop one prospect's email sequence: no further steps are sent and the prospect is marked manually-paused, keeping it and its history in the campaign. - [list_linkedin_accounts](/docs/mcp/tools/list-linkedin-accounts): List the LinkedIn accounts connected to a website through the browser extension, newest first. - [list_linkedin_campaigns](/docs/mcp/tools/list-linkedin-campaigns): List the LinkedIn connection-request campaigns of a website, newest first, with each campaign's status (draft, active, paused, completed), stats and progress ({ pct, terminalCount, total }). - [get_inbox_emails](/docs/mcp/tools/get-inbox-emails): List prospects from the outreach master inbox of a website across all campaigns, most recent activity first. - [get_email_thread](/docs/mcp/tools/get-email-thread): Read one outreach email conversation: the email that was sent (subject, send time, opens) and every reply under it, incoming and outgoing. - [reply_to_prospect](/docs/mcp/tools/reply-to-prospect): Send a reply email to a prospect in an existing outreach conversation. - [archive_email](/docs/mcp/tools/archive-email): Archive one email conversation in the outreach master inbox so it leaves the inbox view; it stays visible with get_inbox_emails status archived. - [delete_campaign](/docs/mcp/tools/delete-campaign): Permanently delete an email campaign together with all its steps and every prospect in it; scheduled emails are never sent and the history is lost. - **Mailboxes & domains** - [list_email_providers](/docs/mcp/tools/list-email-providers): Returns the SMTP and IMAP host, port and TLS settings of common providers (Gmail, Outlook, Zoho…). - [test_email_account](/docs/mcp/tools/test-email-account): Connects to the SMTP and IMAP servers with these settings and says whether sending and reading work, without saving anything. - [update_warmup_settings](/docs/mcp/tools/update-warmup-settings): Changes how hard a mailbox warms up: intensity conservative, normal or aggressive, and the most warmup emails a day (5-100). - [get_warmup_health](/docs/mcp/tools/get-warmup-health): Returns one mailbox's warmup health: reputation, inbox vs spam placement and what to fix. - [verify_tracking_domain](/docs/mcp/tools/verify-tracking-domain): Checks that a mailbox's custom tracking domain has its CNAME record set, so open and click tracking links use your own domain. - [list_domains](/docs/mcp/tools/list-domains): The domains bought or imported for sending, with their mailboxes, DNS state, expiry date and auto-renew. - [set_domain_auto_renew](/docs/mcp/tools/set-domain-auto-renew): Turns automatic yearly renewal of a sending domain on or off. - [rename_email_account](/docs/mcp/tools/rename-email-account): Changes the sender name a mailbox shows, and for mailboxes on our servers the part of the address before the @. - [reconnect_email_account](/docs/mcp/tools/reconnect-email-account): Tries the saved SMTP and IMAP settings of a disconnected mailbox again; when they work, the mailbox is connected and its paused prospects continue. - [unmark_email_account_spam](/docs/mcp/tools/unmark-email-account-spam): Clears the flag set when a mailbox looked like it was going to spam, so it sends again. - [remove_tracking_domain](/docs/mcp/tools/remove-tracking-domain): Stops using the custom open and click tracking domain of a mailbox; tracking falls back to the shared domain. - [get_email_account](/docs/mcp/tools/get-email-account): One mailbox in full: address, sender name and signature, daily sending limit, warmup state and health, and whether it is connected. - [update_email_account](/docs/mcp/tools/update-email-account): Changes a mailbox: the daily sending limit (queued emails are rescheduled to match), the sender name, company, position, phone and the HTML signature. - [list_email_accounts](/docs/mcp/tools/list-email-accounts): List the mailboxes connected to a website for sending outreach, with their health and warmup state. - [add_email_account](/docs/mcp/tools/add-email-account): Connect an existing mailbox to a website for sending outreach, using its SMTP (sending) and IMAP (reading replies) settings. - [get_email_account_stats](/docs/mcp/tools/get-email-account-stats): Get the sending load of every mailbox on a website: how many campaign emails are scheduled on it and how full its next 30 days are. - [delete_email_account](/docs/mcp/tools/delete-email-account): Remove a connected mailbox from the account. - [toggle_warmup](/docs/mcp/tools/toggle-warmup): Turn email warmup on or off for one mailbox. - [get_warmup_stats](/docs/mcp/tools/get-warmup-stats): Get warmup statistics for all mailboxes on a website: totals (mailboxes, warmup on, connected, warmup emails sent and received) and per mailbox the daily volume, inbox placement and reputation. - [run_deliverability_check](/docs/mcp/tools/run-deliverability-check): Run the deliverability check for one mailbox: SPF, DKIM and DMARC of its domain, its custom tracking domain and an IP blacklist score. - [get_domain_suggestions](/docs/mcp/tools/get-domain-suggestions): Suggest look-alike domain names for cold outreach, built from the website's own domain and keeping its ending (e.g. - [search_domain_availability](/docs/mcp/tools/search-domain-availability): Check whether a domain can be registered for outreach and what it costs. - [add_outreach_domain](/docs/mcp/tools/add-outreach-domain): Add an available domain to a website's picked list (the purchase cart). - [remove_outreach_domain](/docs/mcp/tools/remove-outreach-domain): Remove a domain from a website's picked list (purchase cart) before it is bought. - [purchase_outreach_domains](/docs/mcp/tools/purchase-outreach-domains): Buy every domain in the website's picked list (added with add_outreach_domain) and set each one up for outreach: registration, DNS, SPF/DKIM/DMARC, a mailbox and warmup. - [get_domain_setup_status](/docs/mcp/tools/get-domain-setup-status): Check the setup progress of the outreach domains bought for a website (unpaid picks are not shown). - [list_outreach_domains](/docs/mcp/tools/list-outreach-domains): List every outreach domain of a website, picked or bought, with its status, setup progress, mailboxes and expiry. - **AI Scout** - [list_ai_scouts](/docs/mcp/tools/list-ai-scouts): Lists the AI Scouts of one website: name, description, status (running or paused), people per day, minimum fit, the sources it reads (readsFrom) and how many people each delivered, plus the website's daily AI Scout limit. - [get_ai_scout](/docs/mcp/tools/get-ai-scout): One AI Scout with its sources, how many people it found, qualified and delivered, and the latest people it picked with why they fit. - [plan_ai_scout](/docs/mcp/tools/plan-ai-scout): Turns a description of who to find ("founders of B2B SaaS companies who talk about outbound on podcasts") into a scout name and the sources it would read. - [create_ai_scout](/docs/mcp/tools/create-ai-scout): Creates an AI Scout and runs it right away. - [update_ai_scout](/docs/mcp/tools/update-ai-scout): Changes an AI Scout's name, description, people per day, minimum fit or sources. - [pause_ai_scout](/docs/mcp/tools/pause-ai-scout): Pauses an AI Scout: no more people are delivered until it is resumed. - [resume_ai_scout](/docs/mcp/tools/resume-ai-scout): Resumes a paused AI Scout. - [run_ai_scout](/docs/mcp/tools/run-ai-scout): Starts a run of an AI Scout now instead of waiting for its daily run. - [delete_ai_scout](/docs/mcp/tools/delete-ai-scout): Deletes an AI Scout: it stops for good and is removed from the list. - [set_ai_scout_daily_limit](/docs/mcp/tools/set-ai-scout-daily-limit): Sets how many AI Scout leads (= credits) the website may receive per day across all its scouts, 1 to 500. - **Web Scraping keywords** - [get_web_scraping](/docs/mcp/tools/get-web-scraping): Web Scraping looks for your keywords on websites across the open web — in the page text or in the scripts a site loads — and adds the companies that match, with their people, as leads under Leads › Web Scraping. - [update_web_scraping](/docs/mcp/tools/update-web-scraping): Turns Web Scraping on or off and sets its keywords (exact or fuzzy match, each can be paused), the daily limit (1-500 leads, 1 credit each) and contacts-only (only companies where we found a person). - [suggest_web_scraping_keywords](/docs/mcp/tools/suggest-web-scraping-keywords): Keyword ideas for Web Scraping: phrases the website's buyers would write about themselves on their own sites (never the seller's own category words). - **Optimize blog** - [list_blog_articles](/docs/mcp/tools/list-blog-articles): Lists the articles on a website's hosted blog (Optimize add-on), newest first. - [get_blog_article](/docs/mcp/tools/get-blog-article): Returns one blog article in full (Optimize add-on): its content blocks, FAQ, every version with its status, the public url and the visits it received. - [create_blog_article](/docs/mcp/tools/create-blog-article): Publishes a hand-written article on the website's hosted blog at /, or saves it as a draft (Optimize add-on). - [update_blog_article](/docs/mcp/tools/update-blog-article): Edits a blog article by saving a new version at the same URL (Optimize add-on). - [clear_blog_cache](/docs/mcp/tools/clear-blog-cache): Clears every cached copy of the website's hosted blog (Optimize add-on), so visitors get the latest version on their next page load. - **Websites & tracking** - [list_websites](/docs/mcp/tools/list-websites): Lists the account's tracked websites, newest first, with _id (the websiteId other tools need), name, url, domain, clientId, status (unverified, verified, removed or failed), trial and credit fields, tags and tracking settings. - [add_website](/docs/mcp/tools/add-website): Creates a new website on the account and returns only its websiteId. - [get_website](/docs/mcp/tools/get-website): Returns one website's details: name, url, domain, clientId, trackingScript (the install snippet), status (unverified, verified, removed or failed), lastVerifiedAt, tracking settings (identifySettings, trackExactVisitors, trackCompanyWithSuggestedContacts, trackPersonalEmails, session recording, email digest), credit limits and remaining, trial dates, tags, intent-topic state, integrations and members. - [get_tracking_pixel](/docs/mcp/tools/get-tracking-pixel): Returns the JavaScript snippet to install on a website so visitors can be identified, plus websiteId, clientId, status and url. - [verify_website](/docs/mcp/tools/verify-website): Loads the website's home page (from its saved url) and checks whether this website's tracking snippet is in the HTML. - [update_website](/docs/mcp/tools/update-website): Changes a website's name, url and tracking settings. - [delete_website](/docs/mcp/tools/delete-website): Deletes a website: tracking stops, it disappears from list_websites and its leads are no longer shown, and its website slot is freed. - [get_website_analytics](/docs/mcp/tools/get-website-analytics): Summarises who the identified leads on a website are, over a date range (default the last 30 days): top 10 industries, all company-size ranges, top 10 job titles and top 5 countries, each with a count. - [get_website_daily_stats](/docs/mcp/tools/get-website-daily-stats): Returns one row per day for a website (default the last 30 days, every day included even with 0): date (YYYY-MM-DD, UTC), leadsIdentified, avgIcpScore and leadsWithIcpScore. - [get_website_diagnostics](/docs/mcp/tools/get-website-diagnostics): Checks why a website may not be producing leads. - [set_website_tags](/docs/mcp/tools/set-website-tags): Sets the labels of a website, used to group websites (for example by client or market) in the websites list. - [set_page_tracking_rules](/docs/mcp/tools/set-page-tracking-rules): Sets the page rules of a website. - [set_website_limits](/docs/mcp/tools/set-website-limits): Sets how many of the account's credits and mailboxes one website may use, for accounts that share them between websites (for example one website per client). - [set_website_billing_mode](/docs/mcp/tools/set-website-billing-mode): For websites you run for your own clients: start a trial until a date (its leads go to 0 when it ends), switch to paid (the leads refill to the website's limit every month on refreshOn, then the date moves on a month) or stop the monthly refill when a client cancels. - [get_country_blacklist](/docs/mcp/tools/get-country-blacklist): Returns the countries whose visitors are never identified on this website (two-letter codes such as DE or FR). - [set_country_blacklist](/docs/mcp/tools/set-country-blacklist): Sets the countries whose visitors are never identified on this website. - [search_locations](/docs/mcp/tools/search-locations): Looks up location names as the location filters expect them: every country with city data, US states (optionally matching q) or cities matching q (optionally within one country). - [get_domain_blacklist](/docs/mcp/tools/get-domain-blacklist): Lists the company domains blocked from becoming leads on a website. - [add_to_domain_blacklist](/docs/mcp/tools/add-to-domain-blacklist): Blocks company domains from becoming new leads on a website (e.g. - [remove_from_domain_blacklist](/docs/mcp/tools/remove-from-domain-blacklist): Deletes a whole named group of blocked domains from a website, so those companies can become leads again. - **Visitors (leads)** - [get_leads](/docs/mcp/tools/get-leads): List the identified visitors (leads) of one website whose last visit falls in a date range, newest first: the exact person (exactPerson: name, email, phone, LinkedIn, position), their company, visitor location, pages viewed, visits, UTM data, tags and lead scores. - [get_lead](/docs/mcp/tools/get-lead): Get one lead's company profile and visit history: company (name, domain, industry, sector, type, founded year, location, employee range, estimated revenue, LinkedIn/Facebook pages), tags, UTM values, pageVisits[] (url, path, timeSpentMs/timeSpentSeconds, visitCount, sorted by time spent) and summary (totalVisits, lastVisit, totalTimeOnSiteMs, referrer), plus CRM record ids when the lead was pushed. - [get_lead_ai_summary](/docs/mcp/tools/get-lead-ai-summary): Get a short AI-written summary (about 50 words) of what this visitor did on your website, based on their company, country and the pages they viewed, ending with one verdict: 'Ready to Buy', 'Research' or 'Just Browsing'. - [tag_lead](/docs/mcp/tools/tag-lead): Attach an existing tag to a lead. - [remove_tags_from_lead](/docs/mcp/tools/remove-tags-from-lead): Remove one tag from a lead. - [hide_lead](/docs/mcp/tools/hide-lead): Hide a lead from the leads list (hide=true, the default) or bring a hidden lead back (hide=false). - [delete_lead](/docs/mcp/tools/delete-lead): Permanently delete one or more leads. - [export_leads_csv](/docs/mcp/tools/export-leads-csv): Queue a CSV export of a website's leads whose last visit falls in the date range. - [enrich_domain](/docs/mcp/tools/enrich-domain): Look up the people known at a company domain and return them as contacts[] (name, position, email, LinkedIn, isDecisionMaker, plus scores against your scoring models when they have job-title rules). - [list_lists](/docs/mcp/tools/list-lists): Lists the contact or company lists of one website with their names and ids. - [create_list](/docs/mcp/tools/create-list): Creates an empty contact or company list on a website and returns it. - [get_list](/docs/mcp/tools/get-list): Returns one list with its contacts or companies, page by page. - [delete_list](/docs/mcp/tools/delete-list): Deletes a list for good. - [remove_list_items](/docs/mcp/tools/remove-list-items): Removes contacts or companies from a list; they stay in the account. - [export_list_csv](/docs/mcp/tools/export-list-csv): Builds a CSV of a list and emails the download link to the user. - [update_filter](/docs/mcp/tools/update-filter): Marks a saved leads filter as a favourite (shown first) or not. - [block_domain](/docs/mcp/tools/block-domain): Adds a company domain to the website exclusions: its visitors are not identified and use no credits. - [block_person](/docs/mcp/tools/block-person): Excludes one person (by email, LinkedIn URL or name) from the leads of a website, e.g. - [purge_leads_below_bar](/docs/mcp/tools/purge-leads-below-bar): Removes the leads already in the table that score below the lead quality bar (get_lead_quality). - [undo_lead_purge](/docs/mcp/tools/undo-lead-purge): Brings back the leads removed by the last purge_leads_below_bar, with their tags, comments and history as they were. - [update_tag](/docs/mcp/tools/update-tag): Renames a tag or changes its colour on this website. - [delete_tag](/docs/mcp/tools/delete-tag): Deletes a tag from this website; it is removed from every lead that had it. - [update_lead_notes](/docs/mcp/tools/update-lead-notes): Sets the free-form notes on a lead, replacing what was there; an empty string clears them. - [get_company_people](/docs/mcp/tools/get-company-people): Other people who work at the company of a lead (name, job title, department, seniority, LinkedIn), optionally only one department, to find the right contact when the visitor was not the buyer. - [rename_list](/docs/mcp/tools/rename-list): Renames a contact or company list of this website. - [set_session_recording](/docs/mcp/tools/set-session-recording): Turns session recordings on or off for one website. - [get_lead_quality](/docs/mcp/tools/get-lead-quality): Returns the lead quality settings of a website: the minimum ideal-customer score a lead needs to be kept, the bar per source (website visitors, intent, Web Scraping, Prospector, AI Scout), contacts-only options and the audience focus (B2B, B2C or both). - [update_lead_quality](/docs/mcp/tools/update-lead-quality): Changes the lead quality settings of a website. - [list_tags](/docs/mcp/tools/list-tags): List the tags available on a website: the website's own tags plus the built-in default tags. - [create_tag](/docs/mcp/tools/create-tag): Create a new tag on a website so you can label leads with tag_lead. - [list_filters](/docs/mcp/tools/list-filters): List the saved lead filters (saved views) of a website. - [create_filter](/docs/mcp/tools/create-filter): Save a lead filter under a name so it shows as a saved view on the leads page and can be used as an automation segment. - [delete_filter](/docs/mcp/tools/delete-filter): Delete a saved lead filter. - [get_lead_comments](/docs/mcp/tools/get-lead-comments): Get the comments (team notes) on a lead. - [add_lead_comment](/docs/mcp/tools/add-lead-comment): Add a note to a lead, visible to everyone on the account's team, signed with the connected user's name. - [update_lead_comment](/docs/mcp/tools/update-lead-comment): Replace the text of an existing lead comment. - [delete_lead_comment](/docs/mcp/tools/delete-lead-comment): Permanently delete a comment from a lead. - [get_lead_recordings](/docs/mcp/tools/get-lead-recordings): List session recordings (replays of what a visitor did on your website), newest first, up to 100. - [get_recording_url](/docs/mcp/tools/get-recording-url): Get a signed playback link for one session recording. - [Use these docs with AI](/docs/ai): Every page is machine-readable, so AI assistants can find, read and recommend the right Happierleads feature.