# Ethora Chats API

**Canonical:** https://apis.io/apis/ethora-com/ethora-com-chats-api/  
**Provider:** Ethora — https://apis.io/providers/ethora-com/  
**Base URL:** https://api.chat.ethora.com  
**Documentation:** https://api.chat.ethora.com/api-docs/

Ethora Chats API is one of 9 APIs that [Ethora](https://apis.io/providers/ethora-com/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 2 JSON Schema definitions. Tagged areas include Chats. The published artifact set on APIs.io includes an OpenAPI specification and 2 JSON Schemas.

Chat endpoints (rooms, members, messages helpers) complementing the primary XMPP chat flow.

## Operations (46)

| Method | Path | Summary |
|---|---|---|
| POST | `/v2/chats/broadcast` | Async broadcast announcement to selected chat rooms |
| GET | `/v2/chats/broadcast/{jobId}` | Get broadcast job status/results |
| POST | `/v2/apps/{appId}/chats/broadcast` | Async broadcast announcement to selected chat rooms in an app (v2, tenant actor) |
| GET | `/v2/apps/{appId}/chats/broadcast/{jobId}` | Get app-scoped broadcast job status/results (v2, tenant actor) |
| POST | `/v1/chats` | Create chat |
| GET | `/v1/chats` | get chats created by current auth user |
| DELETE | `/v1/chats` | Delete a chat |
| POST | `/v2/chats` | Create chat (v2) |
| GET | `/v2/chats` | get chats created by current auth user (v2) |
| POST | `/v1/chats/private` | Create private chat |
| POST | `/v1/chats/call/create/{chatName}` | Create chat call |
| POST | `/v1/chats/call/state/ringing/{callId}` | Update call state to ringing |
| POST | `/v1/chats/calls/scheduled` | Schedule a call in a chat room |
| GET | `/v1/chats/calls/scheduled` | List scheduled calls |
| GET | `/v1/chats/calls/scheduled/{slug}` | Read a scheduled call |
| PATCH | `/v1/chats/calls/scheduled/{slug}` | Update a scheduled call |
| DELETE | `/v1/chats/calls/scheduled/{slug}` | Cancel a scheduled call |
| POST | `/v1/chats/reports/{chatName}` | Report |
| GET | `/v2/apps/{appId}/chats` | List all chats in an app (v2, tenant actor) |
| POST | `/v2/apps/{appId}/chats` | Create a chat in a target app (v2, tenant actor) |
| DELETE | `/v2/apps/{appId}/chats` | Delete a chat in a target app (v2, tenant actor) |
| POST | `/v2/apps/{appId}/chats/private` | Create a 1-1 chat between two app users (v2, tenant actor) |
| POST | `/v2/apps/{appId}/chats/users-access` | Add chat members in a target app (v2, tenant actor) |
| DELETE | `/v2/apps/{appId}/chats/users-access` | Remove chat members in a target app (v2, tenant actor) |
| GET | `/v2/apps/{appId}/users/{userId}/chats` | List chats for target user (v2, tenant actor) |
| PATCH | `/v2/apps/{appId}/chats/{chatId}` | Update chat metadata (title/description) (v2, tenant actor) |
| GET | `/v1/chats/my` | list current user's chats |
| GET | `/v1/chats/my/{chatName}` | get my chat by chatName |
| PATCH | `/v1/chats/my/{chatName}` | Partially update the caller's own chat metadata |
| PUT | `/v1/chats/my/{chatName}/mute` | Mute a chat for the current user |
| DELETE | `/v1/chats/my/{chatName}/mute` | Unmute a chat for the current user |
| GET | `/v1/chats/public` | get public chats for current app |
| POST | `/v1/chats/users-access` | add user to chat |
| DELETE | `/v1/chats/users-access` | remove user from chat |
| POST | `/v2/chats/users-access` | add user to chat (v2) |
| DELETE | `/v2/chats/users-access` | remove user from chat (v2) |
| GET | `/v1/chats/users` | Get users / chat members |
| GET | `/v2/chats/users` | Get users / chat members (v2) |
| PATCH | `/v2/chats/users` | Batch update users (chat API) (v2) |
| PATCH | `/v2/apps/{appId}/chats/users` | Batch update users (chat API) (v2, tenant actor) |
| POST | `/v1/chats/media/{chatName}` | Post chat media |
| GET | `/v2/apps/{appId}/chats/{chatId}/messages` | Read message history for a chat (any type) from the MAM archive |
| DELETE | `/v2/apps/{appId}/chats/{chatId}/messages` | Bulk-delete the message history of a chat from the MAM archive |
| GET | `/v2/apps/{appId}/messages/search` | Search archived chat messages by text content |
| GET | `/v2/apps/{appId}/chats/{chatId}/messages/context` | Load message context around a target (for "jump to message" UX) |
| POST | `/v2/apps/{appId}/users/unread-counts` | Batch unread message counts per room for a set of users |

## Machine-readable artifacts (3)

- **OpenAPI** — https://artifacts.apis.io/ethora-com/openapi/ethora-com-chats-api-openapi.yml
- **JSONSchema** — https://artifacts.apis.io/ethora-com/json-schema/ethora-com-chat-user-chats-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/ethora-com/json-schema/ethora-com-chat-users-patch-batch-response-schema.json

## Other Ethora APIs (8)

- [Ethora Agents API](https://apis.io/apis/ethora-com/ethora-com-agents-api/)
- [Ethora AI Widget API](https://apis.io/apis/ethora-com/ethora-com-ai-widget-api/)
- [Ethora Apps API](https://apis.io/apis/ethora-com/ethora-com-apps-api/)
- [Ethora Auth API](https://apis.io/apis/ethora-com/ethora-com-auth-api/)
- [Ethora Files API](https://apis.io/apis/ethora-com/ethora-com-files-api/)
- [Ethora Push API](https://apis.io/apis/ethora-com/ethora-com-push-api/)
- [Ethora Sharelinks API](https://apis.io/apis/ethora-com/ethora-com-sharelinks-api/)
- [Ethora Users API](https://apis.io/apis/ethora-com/ethora-com-users-api/)

## Tags

Chats

---

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