Interactive reference for the InstantReply REST API. Try every endpoint live with your API key. Bearer auth, cursor pagination, signed webhooks.
Use the developer endpoints to validate template category fit, submit templates to Meta, read delivery analytics, and get plain-language troubleshooting for known provider errors. The validate endpoint includes UTILITY coaching — it flags marketing phrases and tells you how to qualify for the lower UTILITY rate (~66% cheaper than MARKETING).
POST /v1/templates/:id/validate — category fit + UTILITY coachingPOST /v1/templates/:id/submit — route to MetaGET /v1/trigger/status/:id — explain a delivery outcomeGET /v1/developer/capabilities — scopes + plan featuresGET /v1/developer/onboarding — integration checklistGET /v1/developer/limits — rate limits + quotasGET /v1/developer/troubleshooting/errors/:code — Meta error lookupThe InstantReply REST API gives your app programmatic access to the same AI inbox that powers WhatsApp, Instagram, and Facebook Messenger conversations inside InstantReply. List and read conversations. Send replies. Qualify and route leads. Register signed webhooks so your systems react the moment a customer messages. There are 14 versioned v1 endpoints. API access is free on every plan.
All requests go to https://api.instantreply.co over HTTPS. Authenticate with a scoped Bearer key in the Authorization header. Live and test keys stay separate. Each key is scoped per resource. Keys rotate without downtime.
curl https://api.instantreply.co/v1/conversations \ -H "Authorization: Bearer $IR_API_KEY"
Post a message to any conversation. InstantReply delivers it on the right channel within that channel's messaging window.
curl -X POST https://api.instantreply.co/v1/conversations/$ID/messages \
-H "Authorization: Bearer $IR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"text":"Thanks for reaching out — how can we help?"}'Every list endpoint is cursor-paginated. Pass ?cursor= to fetch the next page, up to 100 records per call.
Register a webhook to receive new messages and lead events in real time. Each endpoint returns a signing secret (whsec_…). Verify the X-IR-Signature header (HMAC-SHA256) on every payload. Delivery is ordered. Failed deliveries retry on an exponential backoff for 30 days.
All endpoints work with standard HTTP — curl, fetch, or requests. No SDK install required. For AI agents, the same API is exposed through the InstantReply MCP server, so tools like Claude, Cursor, and Windsurf can read and reply to conversations directly.
New here? Start with the 5-minute quickstart, browse the REST endpoint catalog, read the developer overview, or generate an API key and try every endpoint live below.