Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.reply.io/llms.txt

Use this file to discover all available pages before exploring further.

Reply is an AI-powered sales engagement platform. The Reply API (v3) exposes that platform as a REST API: anything your team does in the dashboard, you can automate from your own code, scripts, or AI agents.

​
At a glance

Every request is an HTTPS call to a /v3 endpoint with your API key in the Authorization header. Here’s a complete one — it also confirms your credentials work: 
curl https://api.reply.io/v3/whoami \
  -H "Authorization: Bearer YOUR_API_KEY"
  • Base URL — https://api.reply.io, with every endpoint under the /v3 prefix (e.g. /v3/sequences).
  • Authentication — a Bearer token in the Authorization header on every request.
  • Format — JSON request and response bodies; errors as application/problem+json.
  • Rate limits — 100 requests / minute and 3,000 / hour, per user.

​
What you can do

The API covers the whole product. Each area maps to a group of endpoints in the reference:
AreaWhat you can manage
Contacts & dataContacts, contact lists, custom fields, and blacklist rules
SequencesMultichannel sequences across email, LinkedIn, calls, and manual tasks
Accounts & templatesConnected email and LinkedIn accounts, plus shared templates
InboxReplies handled through the unified Inbox
SchedulingSending schedules and holiday calendars that control timing
TasksManual tasks assigned to your team
ReportingPerformance reports across every channel
AutomationWebhooks for real-time events and background jobs for long-running work

​
API conventions

The API is predictable on purpose — once you learn one endpoint, the rest behave the same way. REST. Resource URLs are plural and use standard verbs: GET to read, POST to create, PATCH to update, DELETE to remove. Request and response bodies are JSON. Errors. Every 4xx and 5xx response uses application/problem+json. Business errors carry a stable code slug in <resource>.<variant> form, so you can branch on it without parsing prose: 
{
  "title": "Bad Request",
  "status": 400,
  "detail": "Unknown webhook event 'email_clicked'.",
  "code": "webHook.invalidEvent"
}
A 400 validation error instead adds an errors[] array — one entry per invalid field, each pinned to its location by a JSON Pointer. Asynchronous jobs. Long-running operations — email validation, large bulk imports, and the like — return 202 Accepted with a Location header pointing at /v3/background-jobs/{id}. Poll or cancel the job through that Background Jobs endpoint.

​
Authentication

v3 uses Bearer token authentication. Every request must include an Authorization: Bearer <YOUR_API_KEY> header. A missing, malformed, or revoked token returns 401 Unauthorized with the WWW-Authenticate: Bearer header and an empty body. See Authentication for the full walkthrough — getting your key, a curl example, the Master and Organization keys, and verifying credentials against /v3/whoami.

​
Rate limits

Per-user quotas protect the platform: 100 requests / minute and 3,000 requests / hour by default. A 429 response includes a Retry-After header telling you when to retry. Reporting and statistics endpoints enforce tighter caps — see Rate Limits for the full picture.

​
Versioning

v3 is the current, supported version — use it for all new work. API v1 and v2 still respond but are outdated and no longer supported, and will be deprecated in the future. Their documentation lives at apidocs.reply.io.

​
Connect an AI agent

Reply MCP plugs Reply directly into Claude, Cursor, or any MCP-aware AI client, so an agent can use these capabilities without hand-writing HTTP calls.

Reply MCP

Connect Reply to your AI client in minutes.

Authentication

Get an API key and make your first authenticated call.