Complete REST API documentation for WarmySender. Build custom integrations with our email warmup, campaign, and LinkedIn automation APIs.
All API requests require a Bearer token in the Authorization header. Generate API keys from Settings > API Keys in your WarmySender dashboard. Keys are scoped to your workspace and support granular permissions.
Authorization: Bearer your-api-key-here
All API endpoints are available at:
https://warmysender.com/api/v1
API requests are limited to 60 requests per minute per workspace. Rate limit headers are included in all responses:
X-RateLimit-Limit — Maximum requests per windowX-RateLimit-Remaining — Remaining requests in current windowX-RateLimit-Reset — Unix timestamp when the window resetsRetry-After — Seconds to wait (only on 429 responses)GET /api/v1/prospects — List prospects with pagination and filters (returns email, firstName, lastName, company, role, phone, linkedinUrl, customFields, globalStatus)POST /api/v1/prospects — Create a new prospectPUT /api/v1/prospects/:id — Update a prospectDELETE /api/v1/prospects/:id — Delete a prospectGET /api/v1/campaigns — List all campaignsPOST /api/v1/campaigns — Create a new campaignPOST /api/v1/campaigns/:id/enrollments — Enroll prospects in a campaignDELETE /api/v1/campaigns/:id/enrollments — Unenroll prospects (soft-delete)PATCH /api/v1/campaigns/:id — Update campaign settingsGET /api/v1/mailboxes — List connected mailboxesGET /api/v1/mailboxes/:id/stats — Get mailbox health statsGET /api/v1/warmup/status — Get warmup status for all mailboxesPOST /api/v1/warmup/toggle — Enable or disable warmupGET /api/v1/suppressions — List suppressed emailsPOST /api/v1/suppressions — Add emails to suppression listWarmySender sends real-time webhook notifications for key events. Configure webhooks from Settings > Webhooks or via the API.