API Quickstart Tutorial
Get started with the WarmySender REST API in 5 minutes.
Step 1: Create an API Key
• Go to Settings > API Keys.
• Click 'Create Key' and name it (e.g., 'My CRM Integration').
• Select scopes: choose read/write permissions for the resources you need.
• Copy and save the full API key — it is shown only once.
Step 2: Make Your First Request
All API requests use the base URL: https://warmysender.com/api/v1
Authenticate with the header: Authorization: Bearer YOUR_API_KEY
Example — List Your Prospects:
GET /api/v1/prospects
Returns a paginated list of prospects in your workspace.
Example — Add a Prospect:
POST /api/v1/prospects
Body: { 'email': '[email protected]', 'firstName': 'John', 'company': 'Acme' }
Example — List Campaigns:
GET /api/v1/campaigns
Returns all campaigns with status, stats, and configuration.
Step 3: Handle Responses
• Success: 200 OK with JSON response body.
• Created: 201 Created for POST requests.
• Error: 400 (bad request), 401 (unauthorized), 403 (forbidden scope), 404 (not found), 429 (rate limited).
• Rate limits: 60 requests per minute per API key.
Common Use Cases:
- Create and manage campaigns programmatically.
- Sync prospects from your CRM to WarmySender.
- Pull campaign analytics into your dashboard.
- Programmatically manage suppression lists.
- Automate prospect enrollment into campaigns.
- Start/pause campaigns based on external triggers.
Full API Reference:
Visit warmysender.com/docs/integrations for complete endpoint documentation with request/response examples, error codes, and webhook setup.
Best Practices:
- Use read-only scopes when you only need to pull data.
- Store API keys securely — never commit them to code repositories.
- Set expiration dates on keys used for temporary integrations.
- Handle rate limit responses (429) with exponential backoff.
- Use webhooks for real-time events instead of polling the API.