# communicate-so Inbox API

**Canonical:** https://apis.io/apis/communicate-so/communicate-so-inbox-api/  
**Provider:** communicate-so — https://apis.io/providers/communicate-so/  
**Base URL:** https://app.communicate.so/api/v1  
**Documentation:** https://communicate.so/developers

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

The Inbox API from communicate-so — 16 operation(s) for inbox.

## Operations (18)

| Method | Path | Summary |
|---|---|---|
| GET | `/workspaces/{workspaceId}/inbox/{conversationId}/support-requests/live` | List support requests still live on a conversation; each needs a disposition… |
| POST | `/workspaces/{workspaceId}/inbox/{conversationId}/copilot` | Draft, summarise, answer or translate a supplied draft without sending… |
| POST | `/workspaces/{workspaceId}/inbox/{conversationId}/copilot/endorse` | Record that a teammate used a learning-backed copilot suggestion |
| POST | `/workspaces/{workspaceId}/inbox/{conversationId}/attachments/presign` | Stage a reply attachment and return a short-lived upload URL; the file is not… |
| POST | `/workspaces/{workspaceId}/inbox/{conversationId}/attachments/confirm` | Verify and scan an uploaded attachment so a reply can include it |
| GET | `/workspaces/{workspaceId}/inbox/{conversationId}/attachments/{attachmentId}/url` | Return a short-lived download URL for an attachment on this conversation |
| POST | `/workspaces/{workspaceId}/inbox/{conversationId}/messages/{messageId}/retry` | Re-queue a failed or uncertain reply; uncertain delivery requires… |
| POST | `/workspaces/{workspaceId}/inbox/{conversationId}/labels/{labelId}` | Attach a workspace label to a conversation; repeating it is a no-op |
| DELETE | `/workspaces/{workspaceId}/inbox/{conversationId}/labels/{labelId}` | Detach a label from a conversation |
| POST | `/workspaces/{workspaceId}/inbox/{conversationId}/notes` | Add an internal team note to a conversation; visitors never see it |
| POST | `/workspaces/{workspaceId}/inbox/{conversationId}/read` | Mark the caller's conversation read through the latest committed message or… |
| GET | `/workspaces/{workspaceId}/inbox/{conversationId}` | Read a complete accessible ticket thread without marking it seen |
| PATCH | `/workspaces/{workspaceId}/inbox/{conversationId}` | Update ticket status, routing and handling; active support requests require… |
| PATCH | `/workspaces/{workspaceId}/inbox/{conversationId}/messages/{messageId}` | Edit an owned reply using its current lifecycle version |
| POST | `/workspaces/{workspaceId}/inbox/{conversationId}/messages/{messageId}/undo` | Undo an owned queued reply before its undo deadline |
| POST | `/workspaces/{workspaceId}/inbox/{conversationId}/messages` | Queue a human reply using a stable message ID; acceptance does not prove… |
| GET | `/workspaces/{workspaceId}/inbox` | List accessible inbox conversations with existing folder and status filters |
| GET | `/workspaces/{workspaceId}/inbox/counts` | Read accessible inbox folder counts and pending delivery summaries |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/communicate-so/openapi/communicate-so-inbox-api-openapi.yml
- **JSONSchema** — https://artifacts.apis.io/communicate-so/json-schema/communicate-so-read-inbox-conversation-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/communicate-so/json-schema/communicate-so-list-workspace-agents-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/communicate-so/json-schema/communicate-so-create-agent-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/communicate-so/json-schema/communicate-so-duplicate-agent-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/communicate-so/json-schema/communicate-so-fetch-agent-logo-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/communicate-so/json-schema/communicate-so-read-agent-response-schema.json

## Other communicate-so APIs (12)

- [communicate-so Account credentials API](https://apis.io/apis/communicate-so/communicate-so-account-credentials-api/)
- [communicate-so Account preferences API](https://apis.io/apis/communicate-so/communicate-so-account-preferences-api/)
- [communicate-so Agents API](https://apis.io/apis/communicate-so/communicate-so-agents-api/)
- [communicate-so Authentication API](https://apis.io/apis/communicate-so/communicate-so-authentication-api/)
- [communicate-so Chat API](https://apis.io/apis/communicate-so/communicate-so-chat-api/)
- [communicate-so Discovery API](https://apis.io/apis/communicate-so/communicate-so-discovery-api/)
- [communicate-so Grill API](https://apis.io/apis/communicate-so/communicate-so-grill-api/)
- [communicate-so Learnings API](https://apis.io/apis/communicate-so/communicate-so-learnings-api/)
- [communicate-so Notifications API](https://apis.io/apis/communicate-so/communicate-so-notifications-api/)
- [communicate-so Sources API](https://apis.io/apis/communicate-so/communicate-so-sources-api/)
- [communicate-so Teams API](https://apis.io/apis/communicate-so/communicate-so-teams-api/)
- [communicate-so Workspace members API](https://apis.io/apis/communicate-so/communicate-so-workspace-members-api/)

## Tags

Inbox

---

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