# Warmerly documentation > Warmerly is email warmup and cold outreach software. It warms up Gmail and Outlook mailboxes to build sender reputation, then sends email and LinkedIn campaigns from them. WhatsApp is available for inbox replies. This is its complete product documentation and REST API reference. Category: Email warmup and cold outreach software. - API base URL: https://app.warmerly.com/api/v1 (paths in the reference are written without the /api/v1 prefix) - Authentication: send your key in an `X-Api-Key` header; most endpoints also need `X-Project-Id` (see https://warmerly.com/docs/authentication). Create keys at https://app.warmerly.com/settings/api-keys. - Errors and rate limits: https://warmerly.com/docs/errors - AI assistants can also act on a Warmerly workspace directly through the MCP server at https://app.warmerly.com/api/mcp (see https://warmerly.com/docs/ai). - Every page is also Markdown: add `.md` to its address, or `/llms.txt` after it. Search: https://warmerly.com/docs?q=dkim (replace dkim with your words). The full documentation in one file: https://warmerly.com/docs/llms-full.txt ## Start - [Warmerly docs](https://warmerly.com/docs/index.md): Official docs for Warmerly (warmerly.com), the email warmup and cold outreach platform: setup guides, FAQ, troubleshooting and the REST API. Not Warmly.ai. ## Get started - [Authentication](https://warmerly.com/docs/authentication.md): How to authenticate requests to the Warmerly API using an X-Api-Key header, where to generate and revoke a key, and which endpoints also require X-Project-Id. - [Getting started with Warmerly: from signup to your first send](https://warmerly.com/docs/help/getting-started-checklist.md): A checklist for the whole Warmerly journey: create your account, use the free mailbox, connect your own mailbox, set up DNS, add leads and launch a campaign. - [Glossary of Warmerly terms](https://warmerly.com/docs/help/glossary.md): Plain-English definitions of the words used in the Warmerly app: mailbox, OneMail, free (sandbox) mailbox, warmup, ramp, health score and placement test. ## Help centre - [Help Centre](https://warmerly.com/docs/help.md): Answers to common Warmerly questions: using the API, launching a campaign, importing leads, reconnecting a mailbox, changing plans and more. - [How do I use Warmerly with an API?](https://warmerly.com/docs/help/use-the-api.md): Create a key under Settings > Platform API keys (Agency plan or its 7-day trial), send it as X-Api-Key, and call https://app.warmerly.com/api/v1. - [How do I launch my first campaign?](https://warmerly.com/docs/help/launch-first-campaign.md): Go to Campaigns > New campaign, name it and add leads, write your sequence, pick your mailboxes and schedule, then click Launch now. - [How do I import leads from a CSV?](https://warmerly.com/docs/help/import-leads-csv.md): Open a campaign's Audience tab, click Import leads, drop in your CSV, match the Email column (plus any others), then click Import. - [Why did my mailbox disconnect, and how do I reconnect it?](https://warmerly.com/docs/help/reconnect-mailbox.md): Warmerly could no longer sign in, usually after a password change or revoked access. Open the mailbox in Accounts and click Reconnect. - [How do I cancel or change my plan?](https://warmerly.com/docs/help/cancel-or-change-plan.md): Change plan in Settings > Billing with Switch to this plan. To cancel, click Cancel plan in Settings > Billing. You can pause instead. Your data is kept. - [How do I get a free sending mailbox?](https://warmerly.com/docs/help/free-sending-mailbox.md): Every new Warmerly account gets one free mailbox, already warming up. Use it for replies, tests and a small first campaign; connect your own for normal volume. - [OneMail: mailboxes and domains hosted by Warmerly](https://warmerly.com/docs/help/onemail-mailboxes.md): What OneMail is, how to buy a domain or bring your own, what is set up for you, how warmup and sending work, and how it is billed. ## Using Warmerly - [Frequently asked questions](https://warmerly.com/docs/faq.md): Short answers to the questions Warmerly users ask most: what warmup does, how long it takes, what plans include and whether sending is metered. - [How warmup works](https://warmerly.com/docs/how-warmup-works.md): What Warmerly's email warmup actually does: the private warmup network, the daily ramp, why warmup never emails your prospects, and how LinkedIn warmup differs. - [How our email infrastructure works](https://warmerly.com/docs/infrastructure.md): How mail reaches and leaves a Warmerly hosted mailbox: the MX, SPF, DKIM and DMARC records you publish, separate mail lanes, and how a new IP earns volume. - [Plans, limits and allowances](https://warmerly.com/docs/plans-and-limits.md): What each Warmerly plan includes, how mailbox and campaign limits are enforced, and which allowances reset monthly. - [Troubleshooting](https://warmerly.com/docs/troubleshooting.md): Fixes for the problems Warmerly users actually hit: DKIM shown as missing when it exists, Microsoft 365 SMTP errors after OAuth and paused mailboxes. - [Use Warmerly with AI (MCP)](https://warmerly.com/docs/ai.md): Connect Claude, ChatGPT, Claude Code or Cursor to your Warmerly workspace over MCP: look up mailboxes, campaigns, leads and deliverability. ## Prospecting - [How do I find leads with Lead finder?](https://warmerly.com/docs/help/find-leads.md): Describe the companies you want in plain words, or use the filters, then export a CSV or add them straight to a campaign. - [How do I find someone's email address?](https://warmerly.com/docs/help/email-finder.md): Use Email finder to look up a contact address from a company domain, a LinkedIn company URL, or a person's name and company. - [How do I check whether an email address is valid?](https://warmerly.com/docs/help/email-verification.md): Use Email verification to check one address or a whole list before you send. Results are Safe to send, Send with caution, Do not send or Unknown. - [What is the Data library and where do my bulk results go?](https://warmerly.com/docs/help/data-library.md): The Data library holds your saved lists, imports and exports: Email finder and verification jobs, LinkedIn imports and campaign audiences. - [How do lead exports, lookups and verifications use my allowance?](https://warmerly.com/docs/help/prospecting-allowances.md): Which prospecting actions are free and which use a monthly allowance (lead exports, email lookups, email verifications), and when they reset. ## Campaigns & inbox - [How do I write an email sequence for a campaign?](https://warmerly.com/docs/help/email-sequences.md): Open a campaign's Sequence tab, pick a template or start blank, add Email and Wait steps, and edit. A step-by-step guide to writing your sequence. - [What merge tags and custom variables can I use in my emails?](https://warmerly.com/docs/help/merge-tags.md): Built-in tags are email, firstName, lastName, companyName and the sender tags. Any other column you import becomes a custom variable. - [How do I personalise every email with the AI opener?](https://warmerly.com/docs/help/ai-opener.md): Put the ai_opener tag at the top of your email. Warmerly writes a one or two sentence opening line per lead from your campaign brief and the lead's website. - [How do I A/B test a subject line or email in a campaign?](https://warmerly.com/docs/help/ab-test-email-copy.md): On an email step, click Test another version of this email. Warmerly sends up to four versions in rotation and picks the winner once each has enough sends. - [How do I see who has been contacted in a campaign?](https://warmerly.com/docs/help/campaign-audience.md): A campaign's Audience tab lists every lead with its status and how many emails have gone out. Here is how to read each column. - [What do the campaign statuses mean (draft, sending, paused, completed)?](https://warmerly.com/docs/help/campaign-statuses.md): A campaign is a draft until you start it, then sending, scheduled or needs attention while live. What each status means and what to do next. - [Why does my campaign send fewer emails than my daily limit?](https://warmerly.com/docs/help/campaign-sending-schedule.md): The gap between sends, the sending hours, the volume ramp and each mailbox's own limit usually cap a campaign well below its daily limit. - [Can I launch a campaign before my mailbox has finished warming up?](https://warmerly.com/docs/help/launch-before-warmup-finishes.md): Yes. Build and launch on day one. A new mailbox starts low and climbs each sending day. The free mailbox is for replies, tests and one small first campaign. - [What stops a campaign sequence for a lead?](https://warmerly.com/docs/help/what-stops-a-sequence.md): A reply, an out-of-office reply, a bounce, an unsubscribe, the do-not-contact list, removing the lead or finishing the last step all stop a lead's sequence. - [How do open and click tracking work in a campaign?](https://warmerly.com/docs/help/open-and-click-tracking.md): Turn tracking on under a campaign's Settings > Tracking. Click tracking is on by default, open tracking is off, and plain text mode removes both. - [How do unsubscribe links work in campaign emails?](https://warmerly.com/docs/help/unsubscribe-links.md): With a working custom tracking domain, campaign emails get an unsubscribe link and one-click headers automatically. How they work and what a click does. - [What does the Warmi advice on my campaign mean?](https://warmerly.com/docs/help/campaign-advice.md): The Warmi card on a campaign's Overview and Settings tabs points out problems in your settings and results, and links to the fix. It never blocks you. - [How does the Inbox work? (replies, categories and answering leads)](https://warmerly.com/docs/help/inbox.md): Outreach > Inbox shows replies from every connected mailbox in one place. Replies to your campaigns are sorted into Interested, Not relevant and Spam. ## Deliverability - [What do my mailbox's health score and status mean?](https://warmerly.com/docs/help/mailbox-health.md): How to read a mailbox page in Warmerly: the health score, the Healthy, Warming, Paused, Recovering and Needs attention badges, and what to do about each. - [How do I read the domain health card?](https://warmerly.com/docs/help/domain-health-card.md): What the Health tab on a mailbox checks (SPF, DKIM, DMARC, MX and blocklists), what pass, warn, fail and unknown mean, and how to fix each finding. - [How do inbox placement tests work?](https://warmerly.com/docs/help/placement-tests.md): What a Warmerly placement test sends, where to run it, that each test uses one of your monthly placement tests, and how to read inbox, promotions and spam. - [What if my domain or IP is on a blocklist?](https://warmerly.com/docs/help/blocklisted.md): What a blocklist listing means for cold email, how Warmerly checks for one, what a policy listing is, and how to get delisted. - [Why did my sending slow down or pause?](https://warmerly.com/docs/help/sending-slowed-or-paused.md): How Warmerly protects your sender reputation: the volume ramp, the bounce-rate brake, automatic pauses, slowing after complaints, and how sending recovers. - [My mailbox won't connect: Gmail, Microsoft 365 and other providers](https://warmerly.com/docs/help/mailbox-wont-connect.md): Which fix to use when connecting or reconnecting a mailbox fails: Google app passwords, Microsoft 365 SMTP AUTH and admin approval, and IMAP and SMTP settings. - [What free email deliverability tools does Warmerly have?](https://warmerly.com/docs/help/free-deliverability-tools.md): The free tools on warmerly.com that need no signup: deliverability checker, SPF checker, DMARC checker, email blacklist checker and spam word checker. ## LinkedIn outreach - [How do I connect LinkedIn and send LinkedIn outreach?](https://warmerly.com/docs/help/linkedin-outreach.md): Connect a LinkedIn account with a paid Warmerly Link slot, add it to a campaign as a sender, and send connection requests and messages within safe daily limits. - [What is LinkedIn warmup and how do I turn it on?](https://warmerly.com/docs/help/linkedin-warmup.md): LinkedIn warmup gradually builds human-looking activity on your LinkedIn account so outreach does not get it restricted. - [What is Warmerly Link?](https://warmerly.com/docs/help/warmerly-link.md): Warmerly Link is the LinkedIn side of Warmerly: a paid slot per LinkedIn account, and the LinkedIn search tab in Lead finder. - [Channel accounts: paid slots and overage](https://warmerly.com/docs/help/channel-slots.md): How LinkedIn (Warmerly Link) accounts are paid for: one paid slot per LinkedIn account. - [Which channels can I connect and send from?](https://warmerly.com/docs/help/social-channels.md): Warmerly's Accounts page connects mailboxes and LinkedIn. This page lists what each channel covers, its limits and pacing, and what is not supported. ## Billing & account - [How does Warmerly billing work?](https://warmerly.com/docs/help/how-billing-works.md): Where to see your plan, invoices and payment method, how monthly and annual billing work, which currency you are charged in and what happens on a plan change. - [What happens when my free trial ends?](https://warmerly.com/docs/help/trial-and-first-charge.md): Paid plans start with a free trial and a card. Nothing is charged until the day after the trial ends. See what happens on the last day of your trial. - [Why is my workspace locked, or showing Payment failed?](https://warmerly.com/docs/help/billing-locked.md): The billing-locked screen explained: a failed payment, going over your plan limits, no plan chosen, a cancelled trial or a deleted workspace. - [What happens if I am over my plan's limits?](https://warmerly.com/docs/help/over-plan-limits.md): Going over a mailbox, campaign or prospect limit gives you a grace period with a countdown banner. Nothing is deleted. - [I ran out of verifications or lookups. Can I buy more without changing plan?](https://warmerly.com/docs/help/buy-more-when-you-run-out.md): Yes for five monthly allowances: spend AI credits on an extra block of email verifications, email lookups, LinkedIn lookups, lead exports or placement tests. - [What are AI credits, what uses them, and how do I buy more?](https://warmerly.com/docs/help/ai-credits.md): AI credits pay for AI-written campaign messages and for extra blocks of monthly allowances. Here is what they are and what uses them. - [How do client workspaces work, and how do I pay for a second workspace?](https://warmerly.com/docs/help/agency-client-workspaces.md): On the Agency plan, client workspaces share one pool of allowances with no extra card or setup. On any other plan a second workspace is paid for on its own. - [How do I delete a workspace, and can I get it back?](https://warmerly.com/docs/help/delete-or-restore-workspace.md): The workspace owner can delete a workspace in Settings > Workspaces. It is kept for 30 days and can be restored without a card. - [How do I invite teammates, and what can each role do?](https://warmerly.com/docs/help/team-members-and-roles.md): Invite people to a workspace as Admin or Member. What Owner, Admin and Member can do, how invites work, how to remove someone and how to transfer ownership. - [What is the audit log and what does it show?](https://warmerly.com/docs/help/audit-log.md): Settings > Audit log lists recent activity in your workspace: team changes, mailbox connections, plan changes and API key creation. - [How do I sign in, change my password or email, and secure my account?](https://warmerly.com/docs/help/sign-in-and-security.md): How signing in works (email and password, Google or Microsoft) and how to change your password or login email in Settings > Profile. - [How do I choose which emails Warmerly sends me?](https://warmerly.com/docs/help/email-preferences.md): Settings > Email preferences has four switches: Mailbox alerts, Lead alerts, Setup tips and check-ins, and Product news and offers. - [How does the Warmerly referral programme work?](https://warmerly.com/docs/help/referral-programme.md): Share your link from Settings > Refer a friend. When someone you referred pays their first real invoice, you both get a month of Starter as account credit. - [How do I apply for and activate Warmerly for Startups?](https://warmerly.com/docs/help/warmerly-for-startups.md): Warmerly for Startups gives eligible startups the Growth plan at half price for 12 months. Here is how to apply. - [What happens to my data if I cancel or delete my workspace?](https://warmerly.com/docs/help/data-after-cancelling-or-deleting.md): Cancelling never deletes your data: the workspace moves to Free. Deleting a workspace keeps it for 30 days so you can restore it, then removes it permanently. - [My account is suspended. What can I do and how do I appeal?](https://warmerly.com/docs/help/account-suspended.md): What a suspended Warmerly account means, what stops while it is suspended, the reasons shown, and how to file an appeal from the suspended screen. - [How do I access, correct or delete my personal data?](https://warmerly.com/docs/help/privacy-requests.md): Send a privacy request at warmerly.com/privacy-request or to privacy@warmerly.com. No account is needed. Covers access, correction and deletion of your data. ## Apps & support - [How do I use the Warmerly Android app?](https://warmerly.com/docs/help/android-app.md): The Warmerly Android app sends a push notification when a prospect replies and lets you answer from the notification. - [What can Warmerly support do (and how do I reach a human)?](https://warmerly.com/docs/help/warmi-support-assistant.md): Warmerly support is our AI assistant. It answers from these docs and, when you are signed in, can read your mailbox, campaign, plan and usage data. - [How do I connect, check or revoke an AI app (Claude, ChatGPT, Cursor)?](https://warmerly.com/docs/help/manage-connected-ai-apps.md): What the Allow screen shows when Claude, ChatGPT, Claude Code or Cursor connects to Warmerly, and where to see them under Settings > Connected apps. - [Is Warmerly down? How the status page and incident banners work](https://warmerly.com/docs/help/status-page.md): status.warmerly.com shows whether Warmerly is working, per component, with 90-day uptime and incident updates. - [Where do I see what's new in Warmerly?](https://warmerly.com/docs/help/whats-new.md): Find new features and fixes in the in-app What's new list (the megaphone icon), the public changelog on warmerly.com, and the API changelog in these docs. - [What am I looking at on my Warmerly dashboard?](https://warmerly.com/docs/help/dashboard-overview.md): A tour of the Warmerly Dashboard: the get-started card, deliverability health score, inbox placement, today's sending, alerts and the mailbox table. ## Guides - [Guides](https://warmerly.com/docs/guides.md): Step-by-step setup guides for Warmerly's dashboard, written for non-developers: DKIM, SPF and DMARC records, a custom tracking domain, and connecting mailboxes. - [Email DNS records: the complete checklist](https://warmerly.com/docs/guides/dns-records.md): Every DNS record a sending domain needs, in one place: MX, SPF, DKIM, DMARC and an optional tracking CNAME. Use it as a checklist when you set up a new domain. - [What Is DKIM? (And How to Set It Up)](https://warmerly.com/docs/guides/dkim.md): Fix a 'No DKIM signature found' warning in Warmerly: get your DKIM record from your email provider and add it to your DNS. No technical background needed. - [Set Up DKIM on Namecheap](https://warmerly.com/docs/guides/dkim/namecheap.md): Step-by-step instructions to add a DKIM TXT record to a domain managed in Namecheap DNS, so Warmerly can verify your email authentication. - [Set up DKIM on IONOS](https://warmerly.com/docs/guides/dkim/ionos.md): Step-by-step instructions to add a DKIM TXT record to a domain managed in IONOS DNS, so Warmerly can verify your email authentication. - [Set Up DKIM on GoDaddy](https://warmerly.com/docs/guides/dkim/godaddy.md): Step-by-step instructions to add a DKIM TXT record to a domain managed in GoDaddy DNS, so Warmerly can verify your email authentication. - [Set Up DKIM on Cloudflare](https://warmerly.com/docs/guides/dkim/cloudflare.md): Step-by-step instructions to add a DKIM TXT record to a domain managed in Cloudflare DNS, so Warmerly can verify your email authentication. - [What Are SPF & DMARC? (And How to Set Them Up)](https://warmerly.com/docs/guides/spf-dmarc.md): Fix an SPF or DMARC warning in Warmerly by adding the right DNS records to your domain, with plain-English explanations of what each record does. - [Set Up an SPF Record on Namecheap](https://warmerly.com/docs/guides/spf/namecheap.md): Step-by-step: add an SPF TXT record to a domain managed in Namecheap DNS, avoid the duplicate-record mistake, and get a passing SPF check in Warmerly. - [Set Up a DMARC Record on Namecheap](https://warmerly.com/docs/guides/dmarc/namecheap.md): Step-by-step: add a DMARC TXT record at _dmarc on a domain managed in Namecheap DNS, start with p=none, and get a passing DMARC check in Warmerly. - [Set Up an SPF Record on GoDaddy](https://warmerly.com/docs/guides/spf/godaddy.md): Step-by-step: add an SPF TXT record to a domain managed in GoDaddy DNS, avoid the duplicate-record mistake, and get a passing SPF check in Warmerly. - [Set Up a DMARC Record on GoDaddy](https://warmerly.com/docs/guides/dmarc/godaddy.md): Step-by-step: add a DMARC TXT record at _dmarc on a domain managed in GoDaddy DNS, start with p=none, and get a passing DMARC check in Warmerly. - [Set Up an SPF Record on Cloudflare](https://warmerly.com/docs/guides/spf/cloudflare.md): Step-by-step: add an SPF TXT record to a domain managed in Cloudflare DNS, avoid the duplicate-record mistake, and get a passing SPF check in Warmerly. - [Set Up a DMARC Record on Cloudflare](https://warmerly.com/docs/guides/dmarc/cloudflare.md): Step-by-step: add a DMARC TXT record at _dmarc on a domain managed in Cloudflare DNS, start with p=none, and get a passing DMARC check in Warmerly. - [Set Up an SPF Record on IONOS](https://warmerly.com/docs/guides/spf/ionos.md): Step-by-step: add an SPF TXT record to a domain managed in IONOS DNS, avoid the duplicate-record mistake, and get a passing SPF check in Warmerly. - [Set Up a DMARC Record on IONOS](https://warmerly.com/docs/guides/dmarc/ionos.md): Step-by-step: add a DMARC TXT record at _dmarc on a domain managed in IONOS DNS, start with p=none, and get a passing DMARC check in Warmerly. - [Custom Tracking Domain (And How to Set It Up)](https://warmerly.com/docs/guides/custom-tracking-domain.md): Replace the default shared Warmerly tracking link with your own domain by adding a CNAME record to your DNS. Step-by-step, no technical background needed. - [Connecting a Mailbox](https://warmerly.com/docs/guides/mailbox-connection.md): How to connect a Gmail, Outlook, Zoho, or custom SMTP/IMAP mailbox to Warmerly for warmup and sending, with one-click Microsoft sign-in and Gmail app passwords. - [Deliverability checklist before you launch](https://warmerly.com/docs/guides/deliverability-checklist.md): A step-by-step pre-launch checklist for cold email in Warmerly: DNS records, warmup, list quality, copy, tracking and volume. ## API reference - [Accounts](https://warmerly.com/docs/accounts.md): API reference for Warmerly accounts (mailboxes): connect Gmail, Outlook, or custom SMTP/IMAP inboxes and manage warmup status, ramp schedule, and health score. - [Campaigns](https://warmerly.com/docs/campaigns.md): API reference for Warmerly campaigns: create and manage multi-step email and LinkedIn outbound sequences, their steps, sending accounts, and leads. - [Warmup](https://warmerly.com/docs/warmup.md): API reference for Warmerly warmup: pull mailbox health scores and the inbox-placement emails sent between accounts, to build dashboards or alert on score drops. - [Verify](https://warmerly.com/docs/verify.md): API reference for Warmerly's email verification: check syntax, MX records, disposable/role addresses, and live SMTP deliverability, single or in bulk jobs. - [Email Finder](https://warmerly.com/docs/email-finder.md): API reference for the Warmerly Email Finder: find and verify a person's or company's email from a domain, website, or name, via async jobs you poll. - [Leads](https://warmerly.com/docs/leads.md): API reference for the Warmerly lead database: search millions of crawled companies, export matching rows to CSV, and push them straight into a campaign. - [Inbox](https://warmerly.com/docs/inbox.md): API reference for the Warmerly Inbox: list contacts, pull a unified email/LinkedIn conversation timeline, and send replies across channels. - [Suppression](https://warmerly.com/docs/suppression.md): API reference for the Warmerly suppression list: add addresses that must never be emailed in any campaign, and how addresses get on the list automatically. - [Webhooks](https://warmerly.com/docs/webhooks.md): API reference for Warmerly webhook subscriptions: get HTTP-signed notifications for mailbox health events like score drops, auto-pauses, and OAuth disconnects. - [Workspaces & Projects](https://warmerly.com/docs/workspaces.md): API reference for Warmerly workspaces and projects: the tenant/billing hierarchy that mailboxes, campaigns, and inbox data attach to via X-Project-Id. - [API Keys](https://warmerly.com/docs/keys.md): API reference for managing Warmerly API keys programmatically: create, list, and revoke keys used to authenticate requests to the Warmerly API. - [Usage & limits](https://warmerly.com/docs/usage.md): Read every monthly allowance and every plan limit for a Warmerly workspace over HTTP: GET /usage/quotas for the meters, GET /billing/me?limits=1 for capacity. ## Reference - [Errors & Rate Limits](https://warmerly.com/docs/errors.md): The standard error response shape used across the Warmerly API, plus every documented rate limit: per-key, per-endpoint, and the public-endpoint IP backstop. - [API Changelog](https://warmerly.com/docs/changelog.md): Reverse-chronological log of changes to the Warmerly public API, and the deprecation policy for breaking changes and endpoint removals. ## Topics - [API reference](https://warmerly.com/docs/topics/api-reference.md): The REST API for developers with an API key: accounts, campaigns, warmup, verification, leads, inbox, suppression, webhooks, workspaces, keys and usage. - [Apps & support](https://warmerly.com/docs/topics/apps-and-support.md): The Android app, Warmi the support assistant, AI app connections, the status page and what's new. - [Billing & account](https://warmerly.com/docs/topics/billing-and-account.md): Billing, trials, limits, credits, workspaces, teammates, security, referrals, refunds, your data and suspended accounts. - [Campaigns & inbox](https://warmerly.com/docs/topics/campaigns-and-inbox.md): Writing sequences, merge tags, A/B tests, sending limits, campaign statuses, tracking and the unified Inbox. - [Deliverability](https://warmerly.com/docs/topics/deliverability.md): Health scores, domain health, inbox placement tests, blocklists, and why sending slows down or pauses. - [Get started](https://warmerly.com/docs/topics/get-started.md): The overview, how to authenticate, a first-send walkthrough and a glossary of Warmerly's own words. - [Guides](https://warmerly.com/docs/topics/guides.md): Click-by-click DNS and mailbox setup: SPF, DKIM and DMARC at Namecheap, GoDaddy, Cloudflare and IONOS, a custom tracking domain and a deliverability checklist. - [Help centre](https://warmerly.com/docs/topics/help-centre.md): One question, one answer. Setting up, launching a campaign, importing leads, reconnecting a mailbox, changing your plan. - [LinkedIn outreach](https://warmerly.com/docs/topics/linkedin-outreach.md): Connecting LinkedIn, LinkedIn warmup, Warmerly Link and the channels you can send from. - [Prospecting](https://warmerly.com/docs/topics/prospecting.md): Finding leads and email addresses, checking whether an address is valid, and where your bulk results go. - [Reference](https://warmerly.com/docs/topics/reference.md): Error codes and rate limits, and the API changelog. - [Using Warmerly](https://warmerly.com/docs/topics/using-warmerly.md): How warmup, our email infrastructure, plans and limits work, plus the FAQ and a troubleshooting page. No code. ## More - [Activity and warmup history](https://warmerly.com/docs/accounts/activity-and-warmup-history.md): stats is today-and-7-day counters for one mailbox. "Today" is the UTC day: - [Blocklist status](https://warmerly.com/docs/accounts/blocklist-status.md): Whether the account's sending domain appears on public DNS blocklists. GET returns the last 10 checks; POST runs one now, and returns a recent result with… - [Check settings before you connect](https://warmerly.com/docs/accounts/check-settings-before-you-connect.md): detect takes { "email": "you@yourdomain.com" } (3 to 320 characters) and returns { "detection": { … } }: Warmerly's best guess at the provider, from the… - [Connect an account](https://warmerly.com/docs/accounts/connect-an-account.md): Connects a mailbox using manual SMTP/IMAP credentials. Requires X-Project-Id and a plan that includes the email channel, see the errors below. Fields you send… - [Connect several accounts at once](https://warmerly.com/docs/accounts/connect-several-accounts-at-once.md): Requires X-Project-Id and a plan that includes the email channel (403 channelnotincluded otherwise). Takes { "accounts": [...] }, where each item has email,… - [Disconnect an account](https://warmerly.com/docs/accounts/disconnect-an-account.md): Permanently disconnects and removes the account, including its warmup history. For a Warmerly-hosted mailbox it also suspends the mail account on Warmerly's… - [DNS and domain checks](https://warmerly.com/docs/accounts/dns-and-domain-checks.md): GET returns the last 10 DNS checks for the account, newest first, plus latest as a convenience (the first item of history, or null). POST re-runs the check… - [Domain health (records + blocklists in one call)](https://warmerly.com/docs/accounts/domain-health-records-blocklists-in-one-call.md): The single call behind the domain-health card in the dashboard, and the one to reach for first: it returns the record checks and the blocklist checks for the… - [Get an account](https://warmerly.com/docs/accounts/get-an-account.md): Returns the full account object (abridged above) plus trackingCnameTarget, sandboxSendingBlock (a sentence, only for the free sandbox mailbox), sendingFlag,… - [List accounts](https://warmerly.com/docs/accounts/list-accounts.md): Returns the accounts for a single project when X-Project-Id is set. If you omit X-Project-Id, this endpoint falls back to returning every account across all… - [OAuth-connected accounts](https://warmerly.com/docs/accounts/oauth-connected-accounts.md): Outlook.com and Microsoft 365 accounts can also be connected via OAuth instead of raw SMTP/IMAP credentials. That is a browser sign-in flow built for the… - [Pause, resume and warmup](https://warmerly.com/docs/accounts/pause-resume-and-warmup.md): pause sets the mailbox's status to paused and resume sets it back to active; both return { "ok": true }. resume also clears a campaign-sending pause. If the… - [Placement tests](https://warmerly.com/docs/accounts/placement-tests.md): GET lists this account's 10 most recent placement tests, newest first, with a summary: - [The account object](https://warmerly.com/docs/accounts/the-account-object.md): Responses never include raw credentials: SMTP/IMAP passwords and OAuth tokens are encrypted at rest and stripped from the API response entirely. The object… - [Update an account](https://warmerly.com/docs/accounts/update-an-account.md): Updates settings on an existing account. Only send the fields you want to change. A few of the most commonly used fields: - [Create a campaign](https://warmerly.com/docs/campaigns/create-a-campaign.md): Requires X-Project-Id. Creates a campaign in draft status with one empty email step seeded automatically (edit or replace it via Steps). The project's healthy… - [Delete a campaign](https://warmerly.com/docs/campaigns/delete-a-campaign.md): Deletes the campaign and cascades to its steps, senders, leads, and send history. This cannot be undone. - [Get a campaign](https://warmerly.com/docs/campaigns/get-a-campaign.md): Returns 404 notfound if the campaign doesn't exist and 403 forbidden if it belongs to a workspace you are not a member of. - [Leads](https://warmerly.com/docs/campaigns/leads.md): status is one of queued, active, completed, replied, bounced, unsubscribed, skipped. Each lead is the stored row (so it also has fields such as researchUrl,… - [Leads across every campaign](https://warmerly.com/docs/campaigns/leads-across-every-campaign.md): One flat, paged view of every lead in the project's campaigns, rather than one campaign at a time. Project-scoped (X-Project-Id). - [LinkedIn senders](https://warmerly.com/docs/campaigns/linkedin-senders.md): Connected LinkedIn accounts used for linkedinconnection / linkedinmessage steps. - [List campaigns](https://warmerly.com/docs/campaigns/list-campaigns.md): Requires X-Project-Id. Returns every campaign in the project with live counters joined in (lead/email totals), most recently created first, plus the project's… - [Pause a campaign](https://warmerly.com/docs/campaigns/pause-a-campaign.md): Sets an active campaign's status to paused (pausing one that is already paused is a no-op; any other status returns 409 conflict). Queued sends stop going out… - [Per-lead enrichment and history](https://warmerly.com/docs/campaigns/per-lead-enrichment-and-history.md): emails returns { "emails": [...] }: every message scheduled for that lead in this campaign, ordered by scheduled time, the audit trail for "what did we… - [Preview a rendered message](https://warmerly.com/docs/campaigns/preview-a-rendered-message.md): Renders one step exactly as it would send, merge fields resolved against a real lead, AI opener included, sender identity and footer applied, without sending… - [Readiness check](https://warmerly.com/docs/campaigns/readiness-check.md): Everything that would stop this campaign sending, as a list of checks, the same set the dashboard shows before you press start, and worth calling before POST… - [Resume a campaign](https://warmerly.com/docs/campaigns/resume-a-campaign.md): Sets a paused campaign back to active; any other status returns 409 conflict (use start instead). Re-checks the billing lock (402 billinglocked) and your… - [Senders (email)](https://warmerly.com/docs/campaigns/senders-email.md): Mailboxes (connected Accounts) that send this campaign's emails, rotated in round-robin to spread volume and protect deliverability. - [Start a campaign](https://warmerly.com/docs/campaigns/start-a-campaign.md): Validates the campaign is ready, then flips it to active and sets startedAt (on first start only, later restarts don't reset it). The workspace must not be… - [Stats](https://warmerly.com/docs/campaigns/stats.md): Aggregated counters and rates for the campaign. - [Steps](https://warmerly.com/docs/campaigns/steps.md): Steps are the ordered sequence of touches (email, LinkedIn) leads move through, with a delay before each one. - [The campaign object](https://warmerly.com/docs/campaigns/the-campaign-object.md): status is one of draft, active, paused, completed, archived. The object is the stored campaign row, so it can carry further fields than shown (for example… - [Update a campaign](https://warmerly.com/docs/campaigns/update-a-campaign.md): All fields optional: send only what you want to change. - [Batch status](https://warmerly.com/docs/email-finder/batch-status.md): Returns aggregate progress for a bulk lookup, grouped by job status, for the project in X-Project-Id. A batch id that matches no jobs in that project returns… - [Bulk lookup](https://warmerly.com/docs/email-finder/bulk-lookup.md): Submit up to 1,000 lookups in one request. Each item accepts the same fields as a single lookup. All items are enqueued under a shared batchId you can use to… - [Delete a job](https://warmerly.com/docs/email-finder/delete-a-job.md): Deletes the job and its discovered email records. - [Get a job](https://warmerly.com/docs/email-finder/get-a-job.md): Fetch the current status of a lookup job, whether it came from a single or bulk request. - [List results](https://warmerly.com/docs/email-finder/list-results.md): Lists jobs for the current project, each joined with its winning discovered email (if any), newest first. Cursor-paginated. - [Quota](https://warmerly.com/docs/email-finder/quota.md): Returns your current monthly Email Finder usage. This endpoint is account-level, it does not require X-Project-Id. - [Single lookup](https://warmerly.com/docs/email-finder/single-lookup.md): Submit one lookup. Provide at least one of domain, website, or name, add person to narrow the search to a specific individual at that domain/company. - [account_suspended](https://warmerly.com/docs/errors/account-suspended.md): The account_suspended error from the Warmerly API (HTTP 403): The account is suspended. Returned on every request, including ones made with an API key. - [agency_plan_required](https://warmerly.com/docs/errors/agency-plan-required.md): The agency_plan_required error from the Warmerly API (HTTP 403): This feature (API keys, webhooks) requires the Agency plan. - [bad_request](https://warmerly.com/docs/errors/bad-request.md): The bad_request error from the Warmerly API (HTTP 400): Malformed request body/query, often paired with field errors in `details`. - [billing_locked](https://warmerly.com/docs/errors/billing-locked.md): The billing_locked error from the Warmerly API (HTTP 402): A plan limit or monthly allowance is used up (the code varies by endpoint), or the workspace's… - [campaign_lead_limit](https://warmerly.com/docs/errors/campaign-lead-limit.md): The campaign_lead_limit error from the Warmerly API (HTTP 402): A plan limit or monthly allowance is used up (the code varies by endpoint), or the workspace's… - [conflict](https://warmerly.com/docs/errors/conflict.md): The conflict error from the Warmerly API (HTTP 409): The request conflicts with the resource's current state. - [forbidden](https://warmerly.com/docs/errors/forbidden.md): The forbidden error from the Warmerly API (HTTP 403): Authenticated, but not allowed to access this resource. - [internal_error](https://warmerly.com/docs/errors/internal-error.md): The internal_error error from the Warmerly API (HTTP 500): Something went wrong on Warmerly's end. - [not_found](https://warmerly.com/docs/errors/not-found.md): The not_found error from the Warmerly API (HTTP 404): The resource doesn't exist, or doesn't belong to you. - [payment_required](https://warmerly.com/docs/errors/payment-required.md): The payment_required error from the Warmerly API (HTTP 402): A plan limit or monthly allowance is used up (the code varies by endpoint), or the workspace's… - [plan_capacity](https://warmerly.com/docs/errors/plan-capacity.md): The plan_capacity error from the Warmerly API (HTTP 402): A plan limit or monthly allowance is used up (the code varies by endpoint), or the workspace's… - [quota_exhausted](https://warmerly.com/docs/errors/quota-exhausted.md): The quota_exhausted error from the Warmerly API (HTTP 402): A plan limit or monthly allowance is used up (the code varies by endpoint), or the workspace's… - [service_unavailable](https://warmerly.com/docs/errors/service-unavailable.md): The service_unavailable error from the Warmerly API (HTTP 503): A feature or an upstream service is not available right now. - [too_many_requests](https://warmerly.com/docs/errors/too-many-requests.md): The too_many_requests error from the Warmerly API (HTTP 429): Rate limit exceeded, see below. - [unauthorized](https://warmerly.com/docs/errors/unauthorized.md): The unauthorized error from the Warmerly API (HTTP 401): Missing, invalid, or revoked API key. - [Am I charged for a lookup that finds nothing?](https://warmerly.com/docs/faq/am-i-charged-for-a-lookup-that-finds-nothing.md): No. - [Are replies separated from warmup traffic?](https://warmerly.com/docs/faq/are-replies-separated-from-warmup-traffic.md): Yes. Warmup mail is kept out of your inbox view and never graded. - [Are there rate limits?](https://warmerly.com/docs/faq/are-there-rate-limits.md): Yes, per endpoint group, and they are separate from your plan's monthly allowances. - [Can I bring my own leads?](https://warmerly.com/docs/faq/can-i-bring-my-own-leads.md): Yes, by import, and Warmerly also has its own company and contact database you can search - [Can I get notified instead of polling?](https://warmerly.com/docs/faq/can-i-get-notified-instead-of-polling.md): Yes - subscribe to outbound webhooks for mailbox health events. - [Can I manage several clients in one account?](https://warmerly.com/docs/faq/can-i-manage-several-clients-in-one-account.md): Yes. - [Can I skip warmup if my mailbox is old and already in use?](https://warmerly.com/docs/faq/can-i-skip-warmup-if-my-mailbox-is-old-and-already-in-use.md): You can, but an established mailbox has reputation for its existing sending pattern. - [Can I use a shared or alias mailbox?](https://warmerly.com/docs/faq/can-i-use-a-shared-or-alias-mailbox.md): Yes, with the SMTP/IMAP username set to that mailbox's own address, provided the signed-in - [Can support change my plan for me?](https://warmerly.com/docs/faq/can-support-change-my-plan-for-me.md): No - plan changes are always yours to make, with your own card, at Settings > Billing. - [Can two campaigns share a mailbox?](https://warmerly.com/docs/faq/can-two-campaigns-share-a-mailbox.md): Yes, and they share that mailbox's daily limit rather than each getting a full one. - [Do I have to set up DKIM, SPF and DMARC?](https://warmerly.com/docs/faq/do-i-have-to-set-up-dkim-spf-and-dmarc.md): Yes, for anything you intend to send at scale. - [Do unused monthly allowances roll over?](https://warmerly.com/docs/faq/do-unused-monthly-allowances-roll-over.md): No. Verifications, lookups, exports, placement tests and AI credits reset on the 1st. - [Does it matter who hosts my mailbox?](https://warmerly.com/docs/faq/does-it-matter-who-hosts-my-mailbox.md): No. - [Does Warmerly verify addresses before sending?](https://warmerly.com/docs/faq/does-warmerly-verify-addresses-before-sending.md): Verification is its own tool with its own monthly allowance, and it is worth running on - [Does warmup send email to my prospects?](https://warmerly.com/docs/faq/does-warmup-send-email-to-my-prospects.md): No. - [How do I authenticate?](https://warmerly.com/docs/faq/how-do-i-authenticate.md): An X-Api-Key header, plus X-Project-Id to say which project you are acting in. - [How do I cancel, change my card, or get an invoice?](https://warmerly.com/docs/faq/how-do-i-cancel-change-my-card-or-get-an-invoice.md): Settings > Billing > Cancel plan cancels your plan. - [How do I make sure someone is never contacted again?](https://warmerly.com/docs/faq/how-do-i-make-sure-someone-is-never-contacted-again.md): Add them to the suppression list; suppressed addresses are never sent to by any campaign. - [How long should I warm a mailbox before sending?](https://warmerly.com/docs/faq/how-long-should-i-warm-a-mailbox-before-sending.md): You don't have to wait: a campaign on young mailboxes (under 14 days of warmup) starts slowly - [How many mailboxes do I need?](https://warmerly.com/docs/faq/how-many-mailboxes-do-i-need.md): Work back from volume: mailboxes x daily limit (30/day by default). - [Is Free a trial?](https://warmerly.com/docs/faq/is-free-a-trial.md): No - no card, no expiry, stay as long as you like. - [Is sending metered?](https://warmerly.com/docs/faq/is-sending-metered.md): Not on paid plans. - [Is there a mobile app?](https://warmerly.com/docs/faq/is-there-a-mobile-app.md): Yes, an Android app covering accounts, campaigns, leads and Warmi support chat. - [Is warmup included in my plan?](https://warmerly.com/docs/faq/is-warmup-included-in-my-plan.md): Yes, on every plan including Free, and it is never metered. - [My warmup reply rate is 60% but my campaign replies are near zero. Why?](https://warmerly.com/docs/faq/my-warmup-reply-rate-is-60-but-my-campaign-replies-are-near-zero-why.md): Those are two unrelated metrics with similar names. - [What does "active prospects" mean?](https://warmerly.com/docs/faq/what-does-active-prospects-mean.md): Unique people across your active and paused campaigns, counted workspace-wide - distinct - [What does LinkedIn cost?](https://warmerly.com/docs/faq/what-does-linkedin-cost.md): It is billed per connected account each month, separate from your plan, with no trial. - [What happens when I hit a limit?](https://warmerly.com/docs/faq/what-happens-when-i-hit-a-limit.md): The action is refused with an explanation, and nothing is deleted. - [What is a placement test?](https://warmerly.com/docs/faq/what-is-a-placement-test.md): A probe that sends real email from your mailbox to test mailboxes and reports inbox vs - [What is the 30-day free trial offer?](https://warmerly.com/docs/faq/what-is-the-30-day-free-trial-offer.md): com get 30 days free on any paid plan instead of 7. - [Which plan has API access?](https://warmerly.com/docs/faq/which-plan-has-api-access.md): Agency. - [Who is Warmi?](https://warmerly.com/docs/faq/who-is-warmi.md): The assistant in the chat widget. - [Account](https://warmerly.com/docs/help/glossary/account.md): On the Accounts page, an "account" is any sending identity: a mailbox or a LinkedIn account. - [Audit log](https://warmerly.com/docs/help/glossary/audit-log.md): A record of recent activity by your team and by connected apps, under Settings > Audit log. - [Campaign](https://warmerly.com/docs/help/glossary/campaign.md): A sequence of emails sent to a list of leads from the mailboxes you choose, on a schedule. - [Capacity limit](https://warmerly.com/docs/help/glossary/capacity-limit.md): A live count with no reset, such as mailboxes, active campaigns and active prospects. - [Connected app, and MCP](https://warmerly.com/docs/help/glossary/connected-app-and-mcp.md): An AI assistant (Claude, ChatGPT, Cursor and others) you have allowed into one workspace through the Model Context Protocol (MCP). - [Credit](https://warmerly.com/docs/help/glossary/credit.md): The currency for AI actions and for top-ups. Your plan includes a monthly amount of AI credits. - [Daily limit](https://warmerly.com/docs/help/glossary/daily-limit.md): The most emails a mailbox will send per day. It is shared across every campaign that mailbox sends for. - [Data library](https://warmerly.com/docs/help/glossary/data-library.md): The Data library (sidebar Prospecting > Data library) is where your saved lists, imports and exports are found in one place: bulk jobs from Email finder… - [Free mailbox (also called the sandbox mailbox)](https://warmerly.com/docs/help/glossary/free-mailbox-also-called-the-sandbox-mailbox.md): The mailbox every new account gets at signup, already warming up. - [Grace period and billing lock](https://warmerly.com/docs/help/glossary/grace-period-and-billing-lock.md): If a workspace ends up over its plan, a countdown banner gives it a grace period, during which everything keeps working. - [Health score](https://warmerly.com/docs/help/glossary/health-score.md): A number from 0 to 100 for how likely a mailbox's email is to reach the inbox instead of spam. - [Inbox](https://warmerly.com/docs/help/glossary/inbox.md): Inbox in the sidebar collects replies from every mailbox in one place. - [Lead](https://warmerly.com/docs/help/glossary/lead.md): A person you might email, with their address and company details. - [Mailbox](https://warmerly.com/docs/help/glossary/mailbox.md): An email address Warmerly sends from and reads replies from. - [Monthly allowance](https://warmerly.com/docs/help/glossary/monthly-allowance.md): A monthly meter that resets on the 1st and does not roll over: verifications, email lookups, LinkedIn lookups, lead exports, placement tests, AI credits… - [OneMail](https://warmerly.com/docs/help/glossary/onemail.md): Mailboxes and domains that Warmerly hosts for you, with the DNS and warmup handled. - [Paused, and "campaign sending paused"](https://warmerly.com/docs/help/glossary/paused-and-campaign-sending-paused.md): These are different. A paused mailbox is stopped for both warmup and campaigns and needs attention (for example it needs reconnecting). - [Placement test](https://warmerly.com/docs/help/glossary/placement-test.md): A test that sends real probe emails from a mailbox to a small set of target mailboxes and reports whether each landed in the inbox, promotions or spam. - [Project](https://warmerly.com/docs/help/glossary/project.md): A subdivision inside a workspace for a client or brand, with its own mailboxes, campaigns and inbox. - [Ramp](https://warmerly.com/docs/help/glossary/ramp.md): Starting small and increasing volume over time. There are two: - The warmup ramp: a mailbox's daily warmup volume rises gradually toward its limit. - [Ready-warmed mailbox](https://warmerly.com/docs/help/glossary/ready-warmed-mailbox.md): A OneMail mailbox that is already warm when you buy it, when available. - [Sender](https://warmerly.com/docs/help/glossary/sender.md): A mailbox chosen to send a campaign. Emails are spread across the senders you pick. - [Sequence and merge tag](https://warmerly.com/docs/help/glossary/sequence-and-merge-tag.md): The sequence is the series of emails a campaign sends. - [Slot](https://warmerly.com/docs/help/glossary/slot.md): A unit you buy on top of your plan for one extra account: a Warmerly Link slot for each connected LinkedIn account. - [Suppression list (shown as "Do not contact")](https://warmerly.com/docs/help/glossary/suppression-list-shown-as-do-not-contact.md): Addresses Warmerly must never email from your workspace: hard bounces, spam complaints, unsubscribes and ones you add. - [Tracking domain](https://warmerly.com/docs/help/glossary/tracking-domain.md): Your own web address used for open and click tracking links in campaign emails, instead of Warmerly's. - [Verification, and Email finder](https://warmerly.com/docs/help/glossary/verification-and-email-finder.md): Email verifier (sidebar Prospecting > Email verifier) checks whether an address is likely deliverable before you send. - [Warmerly Link](https://warmerly.com/docs/help/glossary/warmerly-link.md): The name of the LinkedIn side of Warmerly (the LinkedIn search tab of Prospecting > Lead finder): LinkedIn warmup and outreach. - [Warmi](https://warmerly.com/docs/help/glossary/warmi.md): Warmerly's AI support assistant, in the chat button on every page. - [Warmup](https://warmerly.com/docs/help/glossary/warmup.md): Background activity that builds a mailbox's sending reputation: your mailbox exchanges ordinary messages with other mailboxes in Warmerly's warmup… - [Webhook](https://warmerly.com/docs/help/glossary/webhook.md): A web address of yours that Warmerly calls when something happens, such as a mailbox health event. - [Workspace](https://warmerly.com/docs/help/glossary/workspace.md): The top-level container for your account: it owns the plan, the billing, the team members and everything inside it. - [Filter options](https://warmerly.com/docs/inbox/filter-options.md): Returns the projects and email accounts in your workspace that the inbox can be filtered by, for populating a workspace/account picker in your own UI. - [Get a contact's timeline](https://warmerly.com/docs/inbox/get-a-contact-s-timeline.md): Returns the full conversation with a contact across all channels, in chronological order (the most recent 200 messages), plus any autosaved email draft in… - [Get a thread](https://warmerly.com/docs/inbox/get-a-thread.md): Returns the raw messages in a single email thread, chronological order (the most recent 200). {key} is the threadKey from /inbox/threads (URL-encode it,… - [List threads](https://warmerly.com/docs/inbox/list-threads.md): Returns email threads (grouped by threadKey + accountId) with aggregate counts, for building a mailbox-style view. Only email mailboxes in your workspace are… - [Other endpoints](https://warmerly.com/docs/inbox/other-endpoints.md): These cover more specialized inbox workflows and are not detailed here: - [Reply to a contact](https://warmerly.com/docs/inbox/reply-to-a-contact.md): Sends a reply to a contact on a specific channel and appends it to the timeline. Each channel has its own requirements: - [Create a key](https://warmerly.com/docs/keys/create-a-key.md): Each user can hold at most 10 active keys; creating an 11th (without revoking one first) returns 400 with error.code badrequest, error.message toomanykeys and… - [List keys](https://warmerly.com/docs/keys/list-keys.md): Returns all of your active (non-revoked) keys, newest first. The raw secret is never returned, only the id, name, prefix, rate limit, and usage metadata. - [Revoke a key](https://warmerly.com/docs/keys/revoke-a-key.md): Revokes (soft-deletes) the key. Revoked keys fail authentication immediately on their next request, there is no grace period, and revocation cannot be undone. - [Database size](https://warmerly.com/docs/leads/database-size.md): How many companies the lead database currently holds. The crawl adds rows continuously, so these figures move. - [Export quota](https://warmerly.com/docs/leads/export-quota.md): Returns your current lead-export usage for the billing period. A pure read, checking it never debits quota. - [Export to CSV](https://warmerly.com/docs/leads/export-to-csv.md): Exports matching companies as a CSV file (download, not JSON). Debits your monthly lead export quota by the number of rows actually delivered, not the number… - [LinkedIn people search](https://warmerly.com/docs/leads/linkedin-people-search.md): A different database to the company search above: this queries LinkedIn through your own connected LinkedIn account, so it needs a paid LinkedIn slot and a… - [Match count](https://warmerly.com/docs/leads/match-count.md): A search response does not include a match count, because counting inside a search request would make the search slow for everyone. When you need a number for… - [Push to a campaign](https://warmerly.com/docs/leads/push-to-a-campaign.md): Same selection shape as export, plus a target campaign. It adds matching companies directly to a campaign's audience instead of downloading a file and debits… - [Rate limits & errors](https://warmerly.com/docs/leads/rate-limits-and-errors.md): GET /leads/search has its own throttle on top of your API key's per-minute limit: 120 requests per 5 minutes, per user (not per key or IP), and GET… - [Search companies](https://warmerly.com/docs/leads/search-companies.md): Parameters that fail validation return 400 badrequest with the message invalidfilters. - [The company object](https://warmerly.com/docs/leads/the-company-object.md): Most fields can be null when the company does not publish them. inferredCategoryId is a display-only guess made from the company's own text when it declares… - [Add addresses](https://warmerly.com/docs/suppression/add-addresses.md): Requires X-Api-Key. Not project-scoped. The list applies to a whole workspace, not a single project. The workspace is the one named by the X-Workspace-Id… - [How suppression works with campaigns](https://warmerly.com/docs/suppression/how-suppression-works-with-campaigns.md): Suppression is workspace-wide, not per campaign or per project. An opt-out holds across every campaign and every mailbox in the workspace, including campaigns… - [Other ways to add addresses](https://warmerly.com/docs/suppression/other-ways-to-add-addresses.md): Other ways to add addresses in the Warmerly Suppression API reference. - [The list is write-only](https://warmerly.com/docs/suppression/the-list-is-write-only.md): POST /suppression is the only customer-callable endpoint on this resource. Adding an address works with your API key and in the dashboard at Settings > Do not… - [Every monthly allowance](https://warmerly.com/docs/usage/every-monthly-allowance.md): The plan resolved here matches the one the write gates enforce: a workspace with no live subscription is held to Free's allowances rather than the plan it… - [Quotas are not rate limits](https://warmerly.com/docs/usage/quotas-are-not-rate-limits.md): A 402 (quotaexhausted or paymentrequired, depending on the endpoint) means you are out of a monthly allowance; a 429 toomanyrequests means you called too… - [Bulk verification](https://warmerly.com/docs/verify/bulk-verification.md): Submit a list of addresses as an asynchronous batch, then poll for results. Quota for the full batch size is checked up front, before any items are processed. - [Send test (deliverability-grade check)](https://warmerly.com/docs/verify/send-test-deliverability-grade-check.md): Some addresses cannot be settled by SMTP probing alone, a catch-all domain accepts everything, so "accepted" proves nothing. A send test resolves those the… - [The verification object](https://warmerly.com/docs/verify/the-verification-object.md): The verification object in the Warmerly Verify API reference. - [Usage / quota](https://warmerly.com/docs/verify/usage-quota.md): Returns your current verification usage against your plan's limit for the billing period. Checking usage does not itself consume quota. - [Verification history](https://warmerly.com/docs/verify/verification-history.md): Returns the recent single verifications (from POST /verify) recorded against your active workspace, most recent first, cursor-paginated. - [Verify a single email](https://warmerly.com/docs/verify/verify-a-single-email.md): Runs (or reuses a cached) verification for one address. Cached results are returned instantly and are not billable; a fresh check consumes one verification… - [Get warmup stats](https://warmerly.com/docs/warmup/get-warmup-stats.md): Returns a point-in-time summary across your accounts: how many are active, aging, or paused, how many warmup emails have gone out today, and the average… - [Get warmup trends](https://warmerly.com/docs/warmup/get-warmup-trends.md): Returns a daily time series plus a current-vs-previous-window summary, suitable for charting score and inbox-placement rate over time. Backed by daily… - [Is warmup actually running?](https://warmerly.com/docs/warmup/is-warmup-actually-running.md): Whether Warmerly's warmup workers are alive. A plain authenticated caller gets the derived flag: - [List warmup jobs](https://warmerly.com/docs/warmup/list-warmup-jobs.md): Returns individual warmup emails (a "job" is one email sent from one warmed mailbox to another), most recent first. This endpoint doesn't take X-Project-Id.… - [Mailbox health alerts](https://warmerly.com/docs/warmup/mailbox-health-alerts.md): The last 50 mailbox-health alerts that are still open for your user, newest first. Alerts whose fault has since been seen to clear are left out. These are the… - [Pause and resume warmup on an account](https://warmerly.com/docs/warmup/pause-and-resume-warmup-on-an-account.md): Warmup only runs against accounts with status = active or aging. Pausing an account stops it from being scheduled as a sender or recipient in future warmup… - [Per-account health and job history](https://warmerly.com/docs/warmup/per-account-health-and-job-history.md): Two account-scoped endpoints give you the same data filtered to a single mailbox. Both take the account ID from the URL, not X-Project-Id. - [Create a subscription](https://warmerly.com/docs/webhooks/create-a-subscription.md): Each user can hold at most 10 subscriptions that have not been deleted (disabled ones count); creating an 11th returns 400 toomanysubscriptions. - [Delete a subscription](https://warmerly.com/docs/webhooks/delete-a-subscription.md): Revokes (soft-deletes) the subscription; deliveries stop immediately. Not gated on plan tier, a downgraded workspace can still turn off deliveries it can no… - [Delivery & retries](https://warmerly.com/docs/webhooks/delivery-and-retries.md): Deliveries are dispatched by a background sweep (not real-time) that polls for new events every 5 minutes. Each delivery is a POST to your targetUrl, with… - [Event types](https://warmerly.com/docs/webhooks/event-types.md): Pass one or more of these in eventTypes when creating a subscription: - [Known gaps in this page](https://warmerly.com/docs/webhooks/known-gaps-in-this-page.md): Known gaps in this page in the Warmerly Webhooks API reference. - [List subscriptions](https://warmerly.com/docs/webhooks/list-subscriptions.md): Returns your active (non-revoked) subscriptions. The secret is masked to its last 4 characters, it's only shown in full at creation time. - [Update a subscription](https://warmerly.com/docs/webhooks/update-a-subscription.md): Currently the only supported update is toggling active, there's no way to change targetUrl or eventTypes in place; delete and recreate the subscription… - [Invites](https://warmerly.com/docs/workspaces/invites.md): Requires owner or admin. - [Members](https://warmerly.com/docs/workspaces/members.md): Requires owner or admin. - [Projects](https://warmerly.com/docs/workspaces/projects.md): A project hangs off a workspace and is what campaigns, mailboxes, and inbox data attach to via X-Project-Id. Each workspace has exactly one project. Unlike… - [Roles](https://warmerly.com/docs/workspaces/roles.md): Workspace members have one of three roles: - [Workspace housekeeping](https://warmerly.com/docs/workspaces/workspace-housekeeping.md): activate switches which workspace is "current" for session-based (dashboard) use and returns { "ok": true }. API-key callers rarely need it: pass… - [Workspaces](https://warmerly.com/docs/workspaces/workspaces.md): Returns every workspace you're a member of.