Talk to us

ColdMeetings documentation

Open as markdown

For AI agents: the docs index is at /llms.txt, and every page is also served as markdown at its URL plus .md.

ColdMeetings runs cold email operations from one account and one API: sending domains, mailboxes, verified prospects, multi step sequences, replies and booked meetings. These pages explain how the API works and list every operation.

What the API covers#

GroupWhat it does
AccountYour account, its plan and its prospect credits, a full export of your data, plus the two public endpoints that need no key.
DomainsSending domains. Register a domain you own, publish its records and check that they are live. Only mailboxes on a domain that passes the check may send.
MailboxesMailboxes on your sending domains, and how many messages they may send today. New mailboxes ramp up with real low volume sends.
CampaignsA campaign is a sequence of steps, a list of prospects and a status. This is where credits are spent: each imported prospect costs one.
RepliesReplies from prospects. An opt out is caught by a fixed rule before any model runs. A reply that asks for a meeting can be booked from here.
EventsDelivery events. Bounces and complaints suppress the address at once, and enough complaints pause the campaign.
SuppressionsThe do not contact list. Bounces, complaints and opt out replies land here by themselves. You can add an address too.

From an account to a running campaign#

  1. Choose a plan. Email hello@coldmeetings.com with the plan you want and we set up your account and send your first API key. See Credits and billing.
  2. Register a sending domain you own and publish its SPF, DKIM and DMARC records. See Domains.
  3. Check live DNS until the domain is authenticated, then add mailboxes on it. See Mailboxes.
  4. Create a campaign with its sequence and import prospects. Each imported prospect costs one credit. See Campaigns.
  5. Run preflight to list what still blocks a launch, then launch.
  6. Report delivery events and replies back, and book meetings from interested replies. See Events and Replies.

The Quickstart walks through these steps with real request bodies.

Conventions#

  • Base URL: YOUR_API_BASE_URL.
  • Authentication: Authorization: Bearer cm_live_.... See Authentication.
  • Requests and responses are JSON with snake_case field names.
  • Errors share one envelope with a stable code, a fix, a retryable flag and a request_id. See Errors.
  • Authenticated requests are rate limited per key. See Rate limits.

Limits to know#

  • API keys are created by the operator on request.
  • A step that needs an outside service answers 503 provider_unavailable when that service cannot be reached. Nothing is simulated.
  • Prospects in the EU, UK and Israel are skipped as region_blocked.

For agents and scripts#

  • The OpenAPI 3.1 document is at https://coldmeetings.com/openapi.json.
  • Every page on this site has a markdown copy: add .md to its address, or send Accept: text/markdown. The site index for agents is llms.txt.
Documentation menu