JavaScript SDK

ColdMail API — JavaScript Client

A lightweight fetch wrapper for Node.js and browser environments. Forecast cold email campaign outcomes with minimal setup.

Installation

The SDK is a single module. Copy it into your project or use as a reference for your own integration.

npm install coldmail-api

Or download directly:

curl -O https://www.coldmailcalculator.com/api/sdk/javascript/coldmail.js

Quick Start

import { ColdMail } from "coldmail-api";

const client = new ColdMail({
  apiKey: process.env.COLDMAIL_API_KEY
});

const forecast = await client.forecast({
  emails_sent: 5000,
  reply_rate: 5,
  positive_reply_rate: 30,
  meeting_booking_rate: 20,
  close_rate: 25,
  average_deal_value: 2500,
  campaign_cost: 600
});

console.log(forecast.estimated_revenue);
// 9375
console.log(forecast.roi_multiple);
// 15.6

Configuration

The ColdMail constructor accepts an options object:

OptionTypeDefaultDescription
apiKeystringprocess.env.COLDMAIL_API_KEYAPI key for authentication
baseUrlstringhttps://coldmailcalculator.comAPI base URL
timeoutnumber10000Request timeout in ms

API Reference

client.forecast(inputs)

Sends a forecast request and returns the parsed response.

Input fields:

FieldTypeRequiredDescription
emails_sentnumberYesTotal emails in campaign
reply_ratenumberYesReply rate as percentage
positive_reply_ratenumberYesPositive reply percentage
meeting_booking_ratenumberYesMeeting booking percentage
close_ratenumberYesClose rate percentage
average_deal_valuenumberNoAverage revenue per customer
campaign_costnumberNoTotal campaign cost

Error Handling

try {
  const forecast = await client.forecast(inputs);
} catch (err) {
  if (err.status === 401) {
    console.error("Invalid API key");
  } else if (err.status === 400) {
    console.error("Validation error:", err.body.message);
  } else {
    console.error("Network or server error");
  }
}

Response Format

{
  estimated_replies: 250,
  estimated_positive_replies: 75,
  estimated_meetings: 15,
  estimated_clients: 3.75,
  estimated_revenue: 9375,
  roi_multiple: 15.6,
  cost_per_reply: 2.4,
  cost_per_meeting: 40,
  cost_per_client: 160,
  performance_grade: "strong",
  risk_flags: [],
  recommendations: [
    "Monitor reply quality to maintain positive reply rate"
  ]
}

Build cold email forecasting into your app

One POST request is all it takes. Combine the SDK with your frontend, serverless function, or AI agent.