canonical: https://jentic.com/apis/axis96.com/axis96

# Axis96 Swiftchats

Jentic publishes the only available OpenAPI specification for Swiftchats, keeping it validated and agent-ready. Swiftchats is a WhatsApp Business messaging product from Axis96 that exposes APIs for managing contacts, contact groups, and canned replies, and for sending text, template, and media messages. The API uses HTTP bearer authentication and is suited to teams that need programmatic outbound WhatsApp messaging plus contact-list management.

## For AI agents

Send WhatsApp text, template, and media messages and manage contacts, contact groups, and canned replies through Swiftchats. Designed for outbound messaging workflows.

## Scope

Does not handle SMS, voice calls, or email - use Swiftchats for outbound WhatsApp text, template, and media messaging plus contact and group management only.

## Capabilities

- Send WhatsApp text messages, template messages, and media messages to a contact
- Create, list, update, and delete WhatsApp contacts in the Swiftchats workspace
- Manage contact groups for segmenting recipients into reusable lists
- Create and manage canned replies for repeatable agent responses
- Authenticate via HTTP bearer tokens scoped to a Swiftchats workspace

## Use cases

### Transactional WhatsApp Notifications

E-commerce and service teams can send order updates, appointment reminders, and shipping notifications over WhatsApp by calling `/api/send/template` with a pre-approved Meta template. Swiftchats handles the WhatsApp Business API plumbing so the integrating app only needs to map data into the template's variables. Suited to operational notifications where templated content is required.

Example prompt: POST `/api/send/template` with the customer's number and an order_update template populated with order id and ETA

### Contact List and Segment Management

Marketing operators can build and maintain WhatsApp contact lists and groups for segmented sends. The `/api/contacts` and `/api/contact-groups` endpoints support full CRUD on contacts and groups by uuid. Useful for keeping the messaging audience in sync with a CRM or e-commerce store.

Example prompt: POST `/api/contact-groups` with a name and member uuids to create a 'high-value-customers' group, then verify membership via GET `/api/contact-groups`

### Media-Rich Marketing Sends

Marketing teams can send WhatsApp media messages - images, documents, or videos - via `/api/send/media` for promotions and product launches. Combined with canned replies on `/api/canned-replies`, agents can keep response handling consistent. Suitable for campaigns where rich media drives conversion.

Example prompt: POST `/api/send/media` with a contact uuid and an image URL to deliver a promotional image to the recipient

### Agent-Driven WhatsApp Outreach via Jentic

A customer-success agent can send personalised WhatsApp messages and manage contact groups through Jentic without holding the Swiftchats bearer token. Jentic exposes the send, contacts, and groups operations as discoverable tools the agent can chain. Suited to outbound-comms copilots and re-engagement campaigns.

Example prompt: Search Jentic for 'send a whatsapp message', load POST `/api/send`, and execute it to message a contact with a personalised follow-up

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/api/send` | Send a WhatsApp text message |
| POST | `/api/send/template` | Send a WhatsApp template message |
| POST | `/api/send/media` | Send a WhatsApp media message |
| GET | `/api/contacts` | List contacts |
| POST | `/api/contacts` | Create a contact |
| GET | `/api/contact-groups` | List contact groups |
| GET | `/api/canned-replies` | List canned replies |

## Key resources

- **Contacts** — List, create, update, and delete WhatsApp contacts identified by uuid
- **Contact Groups** — Manage named groups of contacts for segmented sends
- **Canned Replies** — Reusable response templates for agents handling inbound messages
- **Send** — Send text, template, and media WhatsApp messages to a contact

## Why Jentic

- **Setup:** Wiring Swiftchats by hand means handling its bearer auth against swiftchats.axis96.xyz and dealing with Meta's WhatsApp Business template approvals before you can send. Through Jentic you install once, import Swiftchats from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** Swiftchats carries the recipient and message content in the request body rather than in a URL path segment, so scoping is by operation. You limit the agent to the operations it needs, such as POST `/api/send` for text or GET `/api/contacts` to read the list, and operations like deleting a contact or a contact group stay out unless you add them.
- **Credential handling:** Your Swiftchats bearer token is stored once, encrypted, by your own Jentic One instance and attached to the Authorization header at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'send a whatsapp message' or 'create a contact group', and Jentic returns the matching Swiftchats operation with its input schema so the agent calls the right endpoint without reading the docs.

## Related APIs

- **MessageBird API** — MessageBird offers a multi-channel messaging API including WhatsApp, SMS, and voice as a competing platform.
- **Twilio API** — Twilio provides WhatsApp, SMS, and voice via a mature messaging platform.
- **Chatwoot API** — Open-source customer support inbox that pairs with Swiftchats for inbound conversation management.

## FAQ

### Why is there no official OpenAPI spec for Swiftchats?

Swiftchats does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Swiftchats via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the Swiftchats API use?

Swiftchats uses HTTP bearer authentication - the Authorization header carries a workspace-scoped bearer token. Through Jentic, the token is stored encrypted in the vault and attached to each request automatically.

### Can I send WhatsApp template messages with the Swiftchats API?

Yes. POST `/api/send/template` sends a Meta-approved WhatsApp template; POST `/api/send` sends free-form text, and POST `/api/send/media` sends image, document, or video media messages.

### How do I manage WhatsApp contact groups through Swiftchats?

Use the `/api/contact-groups` endpoints to create, list, update, and delete groups by uuid. Group membership pairs with the `/api/contacts` endpoints for full segment management.

### What are the rate limits for the Swiftchats API?

Swiftchats messaging is ultimately gated by Meta's WhatsApp Business platform tier limits and any Swiftchats plan-level quotas. The OpenAPI spec does not declare numeric per-endpoint limits, so check your WhatsApp Business tier and Swiftchats plan.

### How do I send a WhatsApp message through Jentic?

Search Jentic for 'send a whatsapp message', load POST `/api/send`, and execute it with the recipient and message body. Jentic injects the bearer token from the vault automatically.

### Can I limit what my agent is allowed to do with the Swiftchats API?

Yes. Because Swiftchats carries the recipient and message content in the request body rather than in the URL path, you scope access by operation in your own self-hosted Jentic One instance, where your rules decide which operations and credentials the agent may use. You can allow just the operations the agent needs, such as POST `/api/send` to send text or GET `/api/contacts` to read the contact list, while operations like deleting a contact or a contact group stay unavailable unless you explicitly add them. The bearer token is attached at execution time by your instance, so the agent acts only within the operations you have granted.