Warmerly Docs

The official documentation for Warmerly, the email warmup and cold outreach platform (not to be confused with Warmly.ai). It covers setting up and using the product and the full REST API.

New to Warmerly? Start with how warmup works, connecting a mailbox, the FAQ and troubleshooting. Setting up DNS? See SPF and DMARC and DKIM.

The Warmerly API

The Warmerly API lets you connect mailboxes, run email warmup, send campaigns, verify addresses, find emails, and manage your workspace programmatically, the same functionality available in the dashboard, exposed over HTTP.

Using an AI assistant? The whole documentation, API reference included, is available as one Markdown file at docs.warmerly.com/llms-full.txt (index: /llms.txt). See Use with AI.

Base URL

https://app.warmerly.com/api/v1

Quick example

curl https://app.warmerly.com/api/v1/accounts \
  -H "X-Api-Key: wmv_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "X-Project-Id: 8f14e45f-ceea-4c6a-8c8d-6b1a5b5c9c1a"

Not here for the API?

Most questions are not API questions. These pages cover the product itself:

• FAQ - the short answers to what people ask most
• How warmup works - the warmup network, the ramp, and why warmup never emails your prospects
• How our email infrastructure works - how sending is kept safe: separate lanes, how a new sending IP earns volume, and what slows down automatically
• Plans, limits and allowances - what each plan includes and how limits behave
• Troubleshooting - DKIM false alarms, Microsoft 365 SMTP errors, campaigns that will not send
• Use with AI (MCP) - connect Claude, ChatGPT, Claude Code or Cursor to your workspace
• All DNS records - MX, SPF, DKIM, DMARC and tracking, in one checklist
• Guides - step-by-step DNS and mailbox setup, written for non-developers

API resources

See Authentication for how to get an API key and project ID, then jump into the resource you need:

• Accounts: connect and manage mailboxes
• Campaigns: outbound email and LinkedIn sequences
• Warmup: warmup health, stats, and trends
• Verify: single and bulk email verification
• Email Finder: find and enrich email addresses
• Leads: search, export, and push leads from Warmerly's company database
• Inbox: unified inbox, threads, and replies
• Suppression: addresses that must never be sent to
• Webhooks: subscribe to mailbox health events
• Workspaces & Projects: multi-tenant workspace/project management
• API Keys: create and revoke keys
• Usage & Limits: monthly allowances and plan capacity in one call

Conventions

• All request/response bodies are JSON.
• Timestamps are ISO 8601 strings in UTC.
• Resource IDs are UUIDs.
• Errors return a JSON body of the shape { "error": { "code": "...", "message": "..." } } with a matching HTTP status code (400, 401, 403, 404, 409, 429, 500), see Errors & Rate Limits for the full error-code table and every rate limit that applies.
• See the API Changelog for what's changed and the deprecation policy.

What's not documented here

This API reference deliberately excludes:

• Everything under /api/v1/admin/*. These routes back the internal Warmerly admin panel (workspace impersonation, billing overrides, platform-wide stats, support inbox, and similar). They require staff-only session auth, not an API key, they can't be called with the credentials this docs site describes, and exposing their shapes publicly would leak internal operational detail for no customer benefit.
• Inbound provider webhooks (/api/v1/webhooks/resend-inbound, /api/v1/webhooks/unipile). These receive signed callbacks from Warmerly's own infrastructure providers (inbound mail, LinkedIn/WhatsApp, and similar), and they're not something a customer integration calls or points anywhere. The customer-facing webhook feature is outbound subscriptions, where Warmerly calls a URL you provide.
• OAuth callback routes (/api/v1/oauth/* and similar). These exist to complete browser-based OAuth redirect flows initiated from the dashboard; there's no way to drive them directly from an API integration.
• Routes with no stable, versioned contract of their own: internal dashboard plumbing like /api/v1/dashboard/overview, /api/v1/onboarding/*, and /api/v1/tools/* are implementation details of the web app's own UI and may change shape without notice, unlike the endpoints documented in this reference.