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
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 asAuthorization: Bearer <token>(the olderapi_access_tokenheader 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
- GETInbox details
/public/api/v1/inboxes/{inbox_identifier}
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
- GETGet account details
/api/v1/accounts/{account_id} - PATCHUpdate account
/api/v1/accounts/{account_id}
Account AgentBots
- GETList all AgentBots
/api/v1/accounts/{account_id}/agent_bots - POSTCreate an Agent Bot
/api/v1/accounts/{account_id}/agent_bots - GETGet an agent bot details
/api/v1/accounts/{account_id}/agent_bots/{id} - DELETEDelete an AgentBot
/api/v1/accounts/{account_id}/agent_bots/{id} - PATCHUpdate an agent bot
/api/v1/accounts/{account_id}/agent_bots/{id}
Agents
- GETList Agents in Account
/api/v1/accounts/{account_id}/agents - POSTAdd a New Agent
/api/v1/accounts/{account_id}/agents - DELETERemove an Agent from Account
/api/v1/accounts/{account_id}/agents/{id} - PATCHUpdate Agent in Account
/api/v1/accounts/{account_id}/agents/{id}
Canned Responses
- GETList all Canned Responses in an Account
/api/v1/accounts/{account_id}/canned_responses - POSTAdd a New Canned Response
/api/v1/accounts/{account_id}/canned_responses - DELETERemove a Canned Response from Account
/api/v1/accounts/{account_id}/canned_responses/{id} - PATCHUpdate Canned Response in Account
/api/v1/accounts/{account_id}/canned_responses/{id}
Custom Attributes
- GETList all custom attributes in an account
/api/v1/accounts/{account_id}/custom_attribute_definitions - POSTAdd a new custom attribute
/api/v1/accounts/{account_id}/custom_attribute_definitions - GETGet a custom attribute details
/api/v1/accounts/{account_id}/custom_attribute_definitions/{id} - DELETERemove a custom attribute from account
/api/v1/accounts/{account_id}/custom_attribute_definitions/{id} - PATCHUpdate custom attribute in Account
/api/v1/accounts/{account_id}/custom_attribute_definitions/{id}
Contacts
- GETList Contacts
/api/v1/accounts/{account_id}/contacts - POSTCreate Contact
/api/v1/accounts/{account_id}/contacts - GETShow Contact
/api/v1/accounts/{account_id}/contacts/{id} - PUTUpdate Contact
/api/v1/accounts/{account_id}/contacts/{id} - DELETEDelete Contact
/api/v1/accounts/{account_id}/contacts/{id} - GETContact Conversations
/api/v1/accounts/{account_id}/contacts/{id}/conversations - GETSearch Contacts
/api/v1/accounts/{account_id}/contacts/search - POSTContact Filter
/api/v1/accounts/{account_id}/contacts/filter - POSTCreate contact inbox
/api/v1/accounts/{account_id}/contacts/{id}/contact_inboxes - GETGet Contactable Inboxes
/api/v1/accounts/{account_id}/contacts/{id}/contactable_inboxes - POSTMerge Contacts
/api/v1/accounts/{account_id}/actions/contact_merge
Contact Labels
- GETList Labels
/api/v1/accounts/{account_id}/contacts/{id}/labels - POSTAdd Labels
/api/v1/accounts/{account_id}/contacts/{id}/labels
Automation Rule
- GETList all automation rules in an account
/api/v1/accounts/{account_id}/automation_rules - POSTAdd a new automation rule
/api/v1/accounts/{account_id}/automation_rules - GETGet a automation rule details
/api/v1/accounts/{account_id}/automation_rules/{id} - DELETERemove a automation rule from account
/api/v1/accounts/{account_id}/automation_rules/{id} - PATCHUpdate automation rule in Account
/api/v1/accounts/{account_id}/automation_rules/{id}
Help Center
- GETList all portals in an account
/api/v1/accounts/{account_id}/portals - POSTAdd a new portal
/api/v1/accounts/{account_id}/portals - GETGet a portal details
/api/v1/accounts/{account_id}/portals/{portal_slug} - PATCHUpdate a portal
/api/v1/accounts/{account_id}/portals/{portal_slug} - POSTAdd a new category
/api/v1/accounts/{account_id}/portals/{portal_slug}/categories - POSTAdd a new article
/api/v1/accounts/{account_id}/portals/{portal_slug}/articles
Conversations
- GETGet Conversation Counts
/api/v1/accounts/{account_id}/conversations/meta - GETConversations List
/api/v1/accounts/{account_id}/conversations - POSTCreate New Conversation
/api/v1/accounts/{account_id}/conversations - POSTConversations Filter
/api/v1/accounts/{account_id}/conversations/filter - GETConversation Details
/api/v1/accounts/{account_id}/conversations/{conversation_id} - PATCHUpdate Conversation
/api/v1/accounts/{account_id}/conversations/{conversation_id} - POSTToggle Status
/api/v1/accounts/{account_id}/conversations/{conversation_id}/toggle_status - POSTToggle Priority
/api/v1/accounts/{account_id}/conversations/{conversation_id}/toggle_priority - POSTToggle Typing Status
/api/v1/accounts/{account_id}/conversations/{conversation_id}/toggle_typing_status - POSTUpdate Last Seen
/api/v1/accounts/{account_id}/conversations/{conversation_id}/update_last_seen - POSTUpdate Custom Attributes
/api/v1/accounts/{account_id}/conversations/{conversation_id}/custom_attributes - POSTDestroy Custom Attributes
/api/v1/accounts/{account_id}/conversations/{conversation_id}/destroy_custom_attributes - GETList Labels
/api/v1/accounts/{account_id}/conversations/{conversation_id}/labels - POSTAdd Labels
/api/v1/accounts/{account_id}/conversations/{conversation_id}/labels - GETConversation Reporting Events
/api/v1/accounts/{account_id}/conversations/{conversation_id}/reporting_events
Conversation Assignments
- POSTAssign Conversation
/api/v1/accounts/{account_id}/conversations/{conversation_id}/assignments
Inboxes
- GETGet account branded email layout
/api/v1/accounts/{account_id}/branded_email_layout - PATCHUpdate account branded email layout
/api/v1/accounts/{account_id}/branded_email_layout - GETList all inboxes
/api/v1/accounts/{account_id}/inboxes - POSTCreate an inbox
/api/v1/accounts/{account_id}/inboxes - GETGet an inbox
/api/v1/accounts/{account_id}/inboxes/{id} - PATCHUpdate Inbox
/api/v1/accounts/{account_id}/inboxes/{id} - GETList WhatsApp message templates
/api/v1/accounts/{account_id}/inboxes/{id}/message_templates - GETShow Inbox Agent Bot
/api/v1/accounts/{account_id}/inboxes/{id}/agent_bot - POSTAdd or remove agent bot
/api/v1/accounts/{account_id}/inboxes/{id}/set_agent_bot - GETList Agents in Inbox
/api/v1/accounts/{account_id}/inbox_members/{inbox_id} - POSTAdd a New Agent
/api/v1/accounts/{account_id}/inbox_members - DELETERemove an Agent from Inbox
/api/v1/accounts/{account_id}/inbox_members - PATCHUpdate Agents in Inbox
/api/v1/accounts/{account_id}/inbox_members
Labels
- GETList all labels
/api/v1/accounts/{account_id}/labels - POSTCreate a label
/api/v1/accounts/{account_id}/labels - GETGet a label
/api/v1/accounts/{account_id}/labels/{id} - DELETEDelete a label
/api/v1/accounts/{account_id}/labels/{id} - PATCHUpdate a label
/api/v1/accounts/{account_id}/labels/{id}
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
- GETList all the Integrations
/api/v1/accounts/{account_id}/integrations/apps - POSTCreate an integration hook
/api/v1/accounts/{account_id}/integrations/hooks - DELETEDelete an Integration Hook
/api/v1/accounts/{account_id}/integrations/hooks/{hook_id} - PATCHUpdate an Integration Hook
/api/v1/accounts/{account_id}/integrations/hooks/{hook_id}
Profile
- GETFetch user profile
/api/v1/profile - PUTUpdate user profile
/api/v1/profile
Teams
- GETList all teams
/api/v1/accounts/{account_id}/teams - POSTCreate a team
/api/v1/accounts/{account_id}/teams - GETGet a team details
/api/v1/accounts/{account_id}/teams/{team_id} - DELETEDelete a team
/api/v1/accounts/{account_id}/teams/{team_id} - PATCHUpdate a team
/api/v1/accounts/{account_id}/teams/{team_id} - GETList Agents in Team
/api/v1/accounts/{account_id}/teams/{team_id}/team_members - POSTAdd a New Agent
/api/v1/accounts/{account_id}/teams/{team_id}/team_members - DELETERemove an Agent from Team
/api/v1/accounts/{account_id}/teams/{team_id}/team_members - PATCHUpdate Agents in Team
/api/v1/accounts/{account_id}/teams/{team_id}/team_members
Custom Filters
- GETList all custom filters
/api/v1/accounts/{account_id}/custom_filters - POSTCreate a custom filter
/api/v1/accounts/{account_id}/custom_filters - GETGet a custom filter details
/api/v1/accounts/{account_id}/custom_filters/{custom_filter_id} - DELETEDelete a custom filter
/api/v1/accounts/{account_id}/custom_filters/{custom_filter_id} - PATCHUpdate a custom filter
/api/v1/accounts/{account_id}/custom_filters/{custom_filter_id}
Webhooks
- GETList all webhooks
/api/v1/accounts/{account_id}/webhooks - POSTAdd a webhook
/api/v1/accounts/{account_id}/webhooks - DELETEDelete a webhook
/api/v1/accounts/{account_id}/webhooks/{webhook_id} - PATCHUpdate a webhook object
/api/v1/accounts/{account_id}/webhooks/{webhook_id}
Reports
- GETAccount Reporting Events
/api/v1/accounts/{account_id}/reporting_events - GETGet Account reports
/api/v2/accounts/{account_id}/reports - GETGet Account reports summary
/api/v2/accounts/{account_id}/reports/summary - GETAccount Conversation Metrics
/api/v2/accounts/{account_id}/reports/conversations - GETAgent Conversation Metrics
/api/v2/accounts/{account_id}/reports/conversations/ - GETGet conversation statistics grouped by channel type
/api/v2/accounts/{account_id}/summary_reports/channel - GETGet conversation statistics grouped by inbox
/api/v2/accounts/{account_id}/summary_reports/inbox - GETGet conversation statistics grouped by agent
/api/v2/accounts/{account_id}/summary_reports/agent - GETGet conversation statistics grouped by team
/api/v2/accounts/{account_id}/summary_reports/team - GETGet first response time distribution by channel
/api/v2/accounts/{account_id}/reports/first_response_time_distribution - GETGet inbox-label matrix report
/api/v2/accounts/{account_id}/reports/inbox_label_matrix - GETGet outgoing messages count grouped by entity
/api/v2/accounts/{account_id}/reports/outgoing_messages_count
Campaigns
- GETList campaigns
/api/v1/accounts/{account_id}/campaigns - POSTCreate a campaign
/api/v1/accounts/{account_id}/campaigns - GETGet a campaign
/api/v1/accounts/{account_id}/campaigns/{id} - DELETEDelete a campaign
/api/v1/accounts/{account_id}/campaigns/{id} - PATCHUpdate a campaign
/api/v1/accounts/{account_id}/campaigns/{id}