How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Chatwoot

Chatwoot Inboxes API

Communication channels setup

Documentation Provider Profile APIs.io OpenAPI GitHub

Chatwoot Inboxes API is one of 40 APIs that Chatwoot publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Inboxes. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 11 operations across 6 paths, and defines 22 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://app.chatwoot.com/, https://app.chatwoot.com.

11 operations 6 paths 22 schemas 2 DELETE4 GET2 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://app.chatwoot.com
Authentication
API Key, API Key, API Key
Terms of Service
View terms
Resource Areas
1

Authentication & Security 3

Chatwoot Inboxes API declares 3 security schemes for authenticating requests. An API key is passed in the header as api_access_token (userApiKey). An API key is passed in the header as api_access_token (agentBotApiKey). An API key is passed in the header as api_access_token (platformAppApiKey).

  • userApiKey — This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can…
  • agentBotApiKey — This token should be provided by system admin or obtained via rails console. This token can be used to build bot integrations and can only access limited apis.
  • platformAppApiKey — This token can be obtained by the system admin after creating a platformApp. This token should be used to provision agent bots, accounts, users and their roles.

Paths & Operations 11

Across 6 paths, the API surfaces 11 operations — 2 DELETE, 4 GET, 2 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Inboxes 11

Communication channels setup

GET
/api/v1/accounts/{account_id}/inboxes
List all inboxes
listAllInboxes 2 params → 200404403
POST
/api/v1/accounts/{account_id}/inboxes
Create an inbox
inboxCreation 2 params body → 200404403
GET
/api/v1/accounts/{account_id}/inboxes/{id}
Get an inbox
GetInbox 4 params → 200404403
PATCH
/api/v1/accounts/{account_id}/inboxes/{id}
Update Inbox
updateInbox 4 params body → 200404403
DELETE
/api/v1/accounts/{account_id}/inboxes/{id}
Delete an inbox.
deleteInbox 2 params → 200
GET
/api/v1/accounts/{account_id}/inboxes/{id}/agent_bot
Show Inbox Agent Bot
getInboxAgentBot 2 params → 204404403
POST
/api/v1/accounts/{account_id}/inboxes/{id}/set_agent_bot
Add or remove agent bot
updateAgentBot 2 params body → 204404403
GET
/api/v1/accounts/{account_id}/inbox_members/{inbox_id}
List Agents in Inbox
get-inbox-members 3 params → 200404403
POST
/api/v1/accounts/{account_id}/inbox_members
Add a New Agent
add-new-agent-to-inbox 1 param body → 200404403422
PATCH
/api/v1/accounts/{account_id}/inbox_members
Update Agents in Inbox
update-agents-in-inbox 1 param body → 200404403422
DELETE
/api/v1/accounts/{account_id}/inbox_members
Remove an Agent from Inbox
delete-agent-in-inbox 1 param body → 200404403422

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are inbox (33 properties), inbox_create_email_channel_payload (21 properties), inbox_update_email_channel_payload (20 properties), inbox_update_payload (17 properties). Each schema is shown below with its type and property counts.

inbox_update_payload
object
17 properties
inbox
object
33 properties
inbox_update_web_widget_channel_payload
object
11 properties
inbox_create_line_channel_payload
object
4 properties 4 required
bad_request_error
object
2 properties
inbox_update_sms_channel_payload
object
2 properties
inbox_create_api_channel_payload
object
4 properties 1 required
inbox_update_whatsapp_channel_payload
object
3 properties
inbox_create_payload
object
17 properties
inbox_update_telegram_channel_payload
object
1 property
inbox_update_email_channel_payload
object
20 properties
agent_bot
object
10 properties
inbox_create_whatsapp_channel_payload
inbox_create_web_widget_channel_payload
object
12 properties 2 required
inbox_update_line_channel_payload
object
3 properties
request_error
object
3 properties
agent
object
11 properties
inbox_create_email_channel_payload
object
21 properties 2 required
inbox_create_telegram_channel_payload
object
2 properties 2 required
inbox_create_sms_channel_payload
object
3 properties 2 required
inbox_update_api_channel_payload
object
3 properties
Inbox
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

chatwoot-inboxes-api-openapi.yml Raw ↑

Other APIs Chatwoot publishes across the network.

Chatwoot Client API
AE Profile APIs.io
Chatwoot Platform API
AE Profile APIs.io
Chatwoot Account AgentBots API
AE Profile APIs.io
Chatwoot Account API
AE Profile APIs.io
Chatwoot Account Users API
AE Profile APIs.io
Chatwoot Accounts API
AE Profile APIs.io
Chatwoot AgentBots API
AE Profile APIs.io
Chatwoot Agents API
AE Profile APIs.io
Chatwoot Audit Logs API
AE Profile APIs.io
Chatwoot Automation Rule API
AE Profile APIs.io
Chatwoot Canned Responses API
AE Profile APIs.io
Chatwoot Contact Labels API
AE Profile APIs.io
#Inboxes
← Back to C APIs
API Details
ID
chatwoot:chatwoot-inboxes-api
Base URL
https://app.chatwoot.com
Docs
https://developers.chatwoot.com/api-reference/introduction
Provider
Chatwoot
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=chatwoot-inboxes-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/chatwoot-inboxes-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Chatwoot Inboxes API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.