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.

​
What V3 gives you

  1. Coverage. The Reply API mirrors the dashboard end-to-end: manage contacts, lists, custom fields, and blacklist rules; orchestrate multichannel sequences across email, LinkedIn, calls, and manual tasks; connect email and LinkedIn accounts and shared templates; handle replies through the unified Inbox; control timing with sending schedules and holiday calendars; track tasks; pull reports across every channel; and automate with webhooks and background jobs.
  2. REST. Plural URLs, GET / POST / PATCH / DELETE, JSON request and response bodies, application/problem+json error responses.
  3. Error responses. Every 4xx and 5xx is application/problem+json. Business errors carry a stable code slug in <resource>.<variant> form (e.g. sequence.notFound); 400 validation responses carry an errors[] array — one entry per offending field, each pinned by a JSON Pointer.
  4. Asynchronous jobs. Long-running operations (email validation, large bulk ingests, …) return 202 Accepted plus a Location header pointing at /v3/background-jobs/{id}. Poll or cancel through the same Background Jobs surface.
  5. Reply MCP. Plug Reply directly into Claude, Cursor, or any MCP-aware AI client. Setup guide →

​
V1 and V2 compatibility

  • V3 is not a drop-in upgrade from V1 or V2. Resource paths, request and response shapes, status codes, and error formats have all changed between versions — plan a migration rather than swapping the base URL.
  • Your existing Reply API key still works. Reply API keys are issued from Settings → API Key in the Reply dashboard and authenticate V1, V2, and V3 requests alike. No re-issue is required to start using V3.

​
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 setup walkthrough, including a curl example and how to verify your credentials against /v3/whoami.

​
Rate limits

Per-user quotas (default 100 requests / minute and 3,000 requests / hour) protect the platform. 429 responses include a Retry-After header. Reporting and statistics endpoints enforce tighter caps — see Rate Limits for the full picture.