Skip to Content
inclamoDocs

API reference

The HTTP API of Inclamo Helpdesk: the Application API and the Client API it inherits from Chatwoot, with a downloadable OpenAPI file.

Last checked 22 November 2026

Inclamo Helpdesk is built on Chatwoot, and its HTTP API is Chatwoot’s. Use it to read and write conversations, contacts and messages from your own tools, or to build your own chat interface.

Base URL: https://helpdesk.inclamo.com

Download the OpenAPI file

Two APIs

  • Application API (/api/v1/…) — what your team can do in the helpdesk, as an API: conversations, messages, contacts, inboxes, labels, teams, reports and more. Authenticate with the access token in your Profile settings in Inclamo Helpdesk, sent as Authorization: Bearer <token> (the older api_access_token header still works). The token acts with your own role and permissions.
  • Client API (/public/api/v1/…) — the public API of an inbox, for a chat interface of your own: create a contact, open a conversation and send messages as the shopper. It needs the inbox’s identifier, not a user’s token.

What this reference covers

  • Chatwoot v4.19.1: 136 operations of the Application API and the Client API, from Chatwoot's OpenAPI file (MIT License).
  • Not included — Platform API (18 operations): accounts and users of the whole installation, for the operator of the installation only.
  • Not included — CSAT survey page (1 operation): an HTML page shown to the customer, not an API.
  • Not included — Audit Logs (1 operation): a Chatwoot Enterprise feature; Inclamo Helpdesk is built on the Community Edition.
  • Not included — Path without the /api prefix (1 operation): /accounts/{account_id}/conversations/{conversation_id}/messages: a duplicate in Chatwoot's file of an Application API path.

Endpoints

Client API

Inbox API

Contacts API

  • POSTCreate a contact/public/api/v1/inboxes/{inbox_identifier}/contacts
  • GETGet a contact/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}
  • PATCHUpdate a contact/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}

Conversations API

  • GETList all conversations/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations
  • POSTCreate a conversation/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations
  • GETGet a single conversation/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}
  • POSTResolve a conversation/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/toggle_status
  • POSTToggle typing status/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/toggle_typing
  • POSTUpdate last seen and mark messages read/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/update_last_seen

Messages API

  • GETList all messages/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/messages
  • POSTCreate a message/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/messages
  • PATCHUpdate a message/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/messages/{message_id}

Application API

Account

Account AgentBots

Agents

Canned Responses

Custom Attributes

Contacts

Contact Labels

  • GETList Labels/api/v1/accounts/{account_id}/contacts/{id}/labels
  • POSTAdd Labels/api/v1/accounts/{account_id}/contacts/{id}/labels

Automation Rule

Help Center

Conversations

Conversation Assignments

  • POSTAssign Conversation/api/v1/accounts/{account_id}/conversations/{conversation_id}/assignments

Inboxes

Labels

Messages

  • GETGet messages/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages
  • POSTCreate New Message/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages
  • DELETEDelete a message/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages/{message_id}
  • PATCHUpdate message status/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages/{message_id}

Integrations

Profile

Teams

Custom Filters

Webhooks

Reports

Campaigns

On this page