# Instant Reply API

**Canonical:** https://apis.io/apis/instantreply-co/instantreply-co-api/  
**Provider:** Instant Reply — https://apis.io/providers/instantreply-co/  
**Base URL:** https://api.instantreply.co/v1  
**Documentation:** https://www.instantreply.co/api-reference

Instant Reply API is one of 2 APIs that [Instant Reply](https://apis.io/providers/instantreply-co/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

Instant Reply API as documented publicly: 72 operations. Contract generated from the documentation by API Evangelist (2026-11-12); not the provider's own document.

## Operations (60 of 72)

| Method | Path | Summary |
|---|---|---|
| GET | `/v1/analytics/summary` | Read response-time, volume, and conversion summary metrics. |
| GET | `/v1/automations` | List available automations. |
| GET | `/v1/automations/{id}` | Read one automation. |
| POST | `/v1/automations/{id}/trigger` | Trigger an automation explicitly. |
| GET | `/v1/campaigns` | List broadcast campaigns. |
| POST | `/v1/campaigns` | Create a campaign draft. |
| GET | `/v1/campaigns/{id}` | Read one campaign. |
| PATCH | `/v1/campaigns/{id}` | Update a draft or scheduled campaign. |
| POST | `/v1/campaigns/{id}/send` | Start an approved campaign send. |
| GET | `/v1/channels` | List connected WhatsApp, Instagram, and Messenger channels. |
| PATCH | `/v1/channels/{integrationId}` | Set DM replies with {ai_enabled} or Instagram/Facebook comment replies with {ai_comment_replies_enabled} for only this connected account; requires automation... |
| GET | `/v1/comments` | List tracked social comments. |
| GET | `/v1/comments/{id}` | Read one tracked social comment. |
| POST | `/v1/comments/{id}/reply` | Reply to a supported social comment. |
| PATCH | `/v1/comments/settings` | Update org-wide comment settings and rules. |
| GET | `/v1/contacts` | List contacts with stage, score, owner, and channel identity. |
| GET | `/v1/contacts/{id}` | Read a contact profile and linked conversation context. |
| PATCH | `/v1/contacts/{id}` | Update contact fields created by lead capture or your CRM. |
| GET | `/v1/conversations` | List conversations with filters for status, channel, assignee, and cursor pagination. |
| POST | `/v1/conversations` | POST /v1/conversations |
| GET | `/v1/conversations/{id}` | Read one conversation with customer, channel, stage, tags, and latest activity. |
| PATCH | `/v1/conversations/{id}` | Update assignment, status, tags, or routing fields for a conversation. |
| GET | `/v1/conversations/{id}/messages` | Read the message history for a conversation. |
| POST | `/v1/conversations/{id}/messages` | Send a reply on the conversation's channel with messages:send and a required Idempotency-Key header. |
| GET | `/v1/developer/capabilities` | Read scopes, enabled features, and integration limits. |
| GET | `/v1/developer/limits` | Read rate limits and plan quotas. |
| GET | `/v1/developer/onboarding` | Read the integration checklist and setup state. |
| GET | `/v1/developer/troubleshooting/errors/{code}` | Look up a known provider error. |
| POST | `/v1/events` | Send an external business event into InstantReply. |
| GET | `/v1/journeys` | List journey templates available to your account. |
| POST | `/v1/journeys` | Create a journey and map approved WhatsApp templates to its steps. |
| GET | `/v1/journeys/{id}` | Read one journey with its mapped templates and step delays. |
| PATCH | `/v1/journeys/{id}/status` | Activate or pause a journey after its template mapping is ready. |
| PUT | `/v1/journeys/{id}/steps` | Replace the journey step map with organization-owned templates. |
| GET | `/v1/keys` | List active API keys and scopes. |
| POST | `/v1/keys` | Create a scoped key for a backend, agent, or test environment. |
| DELETE | `/v1/keys/{id}` | Revoke a key immediately. |
| POST | `/v1/keys/{id}/rotate` | Rotate a key without downtime. |
| GET | `/v1/messages` | List messages across conversations for audit, sync, or analytics jobs. |
| POST | `/v1/messages` | Send free-form content (1–4096 characters) with messages:send and a required Idempotency-Key header. |
| GET | `/v1/messages/{id}` | Fetch delivery and content details for one message. |
| GET | `/v1/pipeline/leads` | List leads in the sales pipeline. |
| GET | `/v1/pipeline/leads/{id}` | Read one lead with stage and conversation context. |
| PATCH | `/v1/pipeline/leads/{id}` | Update lead fields from your CRM or app. |
| PATCH | `/v1/pipeline/leads/{id}/stage` | Move a lead to a new stage. |
| GET | `/v1/pipeline/stages` | List configured pipeline stages. |
| GET | `/v1/status` | Unauthenticated database/Redis dependency health check (200 healthy, 503 degraded). |
| GET | `/v1/templates` | List templates and status from InstantReply and Meta. |
| POST | `/v1/templates` | Create a template draft. |
| DELETE | `/v1/templates/{id}` | Delete a template from Meta and the local registry. |
| GET | `/v1/templates/{id}` | Read a template with category and provider status. |
| POST | `/v1/templates/{id}/send` | Send an approved template using templates:send. |
| POST | `/v1/templates/{id}/submit` | Submit the template to Meta for review. |
| POST | `/v1/templates/{id}/validate` | Check category fit and get UTILITY coaching. |
| GET | `/v1/tickets` | List tickets by status, priority, kind, assignee, or conversation with stable cursor pagination. |
| GET | `/v1/tickets/{id}` | Read one ticket with lifecycle, SLA, assignment, and conversation references. |
| PATCH | `/v1/tickets/{id}` | Update ticket status, priority, assignee, or resolution metadata. |
| POST | `/v1/trigger` | Enroll a contact into a journey or template workflow. |
| POST | `/v1/trigger/batch` | Trigger a batch of contacts with per-row results. |
| DELETE | `/v1/trigger/enrollments` | Cancel active enrollments for a contact or journey. |

…and 12 more operations. They are listed in full on the page.

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/instantreply-co/openapi/_ae-authored/instantreply-co-openapi-generated.yml
- **JSONSchema** — https://artifacts.apis.io/instantreply-co/json-schema/instantreply-co-post-v1-messages-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/instantreply-co/json-schema/instantreply-co-get-v1-conversations-id-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/instantreply-co/json-schema/instantreply-co-patch-v1-conversations-id-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/instantreply-co/json-schema/instantreply-co-patch-v1-tickets-id-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/instantreply-co/json-schema/instantreply-co-post-v1-templates-id-send-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/instantreply-co/json-schema/instantreply-co-get-v1-trigger-status-id-response-schema.json

## Other Instant Reply APIs (1)

- [Instant Reply API](https://apis.io/apis/instantreply-co/instant-reply-api/)

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/instantreply-co/instantreply-co-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/instantreply-co/.