Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Chatwoot Client Conversations API

Client API - end-user conversation management.

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

Tagged areas include Client Conversations. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 5 operations across 4 paths. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against a single base URL, https://app.chatwoot.com.

5 operations 4 paths 0 schemas 1 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://app.chatwoot.com/api/v1/accounts/{account_id}
Authentication
API Key, API Key
Terms of Service
Resource Areas
1

Authentication & Security 2

Chatwoot Client Conversations API declares 2 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 (platformAppApiKey). By default, every request must be authenticated.

  • userApiKey — Application and Client access token passed in the apiaccesstoken HTTP header. For the Application API this is an agent/user access token; Client API requests a…
  • platformAppApiKey — Platform App access token passed in the apiaccesstoken HTTP header. Created by a super-admin from the Chatwoot installation's Platform Apps area and required f…

Paths & Operations 5

Across 4 paths, the API surfaces 5 operations — 1 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Client Conversations 5

Client API - end-user conversation management.

GET
/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations
List the contact's conversations.
listClientConversations 2 params → 200
POST
/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations
Create a conversation for the contact.
createClientConversation 2 params → 200
POST
/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/toggle_status
Toggle the status of the contact's conversation.
toggleClientConversationStatus 3 params → 200
POST
/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/toggle_typing
Signal typing on/off in the conversation.
toggleClientTyping 3 params → 200
POST
/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/update_last_seen
Update the contact's last-seen timestamp for the conversation.
updateClientLastSeen 3 params → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

chatwoot-com-client-conversations-api-openapi.yml Raw ↑

Other APIs Chatwoot publishes across the network.

Chatwoot Agents API
Chatwoot Automation Rules API
Chatwoot Canned Responses API
Chatwoot Client Contacts API
Chatwoot Client Messages API
Chatwoot Contacts API
Chatwoot Conversations API
Chatwoot Custom Attributes API
Chatwoot Inboxes API
Chatwoot Labels API
Chatwoot Messages API
Chatwoot Platform Accounts API