{ "opencollection": "1.0.0", "info": { "name": "Chatwoot Account AgentBots Conversations API", "version": "1.1.0" }, "items": [ { "info": { "name": "Conversations", "type": "folder" }, "items": [ { "info": { "name": "Get Conversation Counts", "type": "http" }, "http": { "method": "GET", "url": "https://app.chatwoot.com/api/v1/accounts/:account_id/conversations/meta", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The numeric ID of the account" }, { "name": "status", "value": "", "type": "query", "description": "Filter by conversation status." }, { "name": "q", "value": "", "type": "query", "description": "Filters conversations with messages containing the search term" }, { "name": "inbox_id", "value": "", "type": "query" }, { "name": "team_id", "value": "", "type": "query" }, { "name": "labels", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "api_access_token", "value": "{{api_access_token}}", "placement": "header" } }, "docs": "Get open, unassigned and all Conversation counts" }, { "info": { "name": "Conversations List", "type": "http" }, "http": { "method": "GET", "url": "https://app.chatwoot.com/api/v1/accounts/:account_id/conversations", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The numeric ID of the account" }, { "name": "assignee_type", "value": "", "type": "query", "description": "Filter conversations by assignee type." }, { "name": "status", "value": "", "type": "query", "description": "Filter by conversation status." }, { "name": "q", "value": "", "type": "query", "description": "Filters conversations with messages containing the search term" }, { "name": "inbox_id", "value": "", "type": "query" }, { "name": "team_id", "value": "", "type": "query" }, { "name": "labels", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "paginate through conversations" } ], "auth": { "type": "apikey", "key": "api_access_token", "value": "{{api_access_token}}", "placement": "header" } }, "docs": "List all the conversations with pagination" }, { "info": { "name": "Create New Conversation", "type": "http" }, "http": { "method": "POST", "url": "https://app.chatwoot.com/api/v1/accounts/:account_id/conversations", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The numeric ID of the account" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "api_access_token", "value": "{{api_access_token}}", "placement": "header" } }, "docs": "Creating a conversation in chatwoot requires a source id. \n\n Learn more about source_id: https://www.chatwoot.com/hc/user-guide/articles/1677839703-how-to-create-an-api-channel-inbox#send-messages-to-the-api-channel" }, { "info": { "name": "Conversations Filter", "type": "http" }, "http": { "method": "POST", "url": "https://app.chatwoot.com/api/v1/accounts/:account_id/conversations/filter", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The numeric ID of the account" }, { "name": "page", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "api_access_token", "value": "{{api_access_token}}", "placement": "header" } }, "docs": "Filter conversations with custom filter options and pagination" }, { "info": { "name": "Conversation Details", "type": "http" }, "http": { "method": "GET", "url": "https://app.chatwoot.com/api/v1/accounts/:account_id/conversations/:conversation_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The numeric ID of the account" }, { "name": "conversation_id", "value": "", "type": "path", "description": "The numeric ID of the conversation" } ], "auth": { "type": "apikey", "key": "api_access_token", "value": "{{api_access_token}}", "placement": "header" } }, "docs": "Get all details regarding a conversation with all messages in the conversation" }, { "info": { "name": "Update Conversation", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.chatwoot.com/api/v1/accounts/:account_id/conversations/:conversation_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The numeric ID of the account" }, { "name": "conversation_id", "value": "", "type": "path", "description": "The numeric ID of the conversation" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "api_access_token", "value": "{{api_access_token}}", "placement": "header" } }, "docs": "Update Conversation Attributes" }, { "info": { "name": "Toggle Status", "type": "http" }, "http": { "method": "POST", "url": "https://app.chatwoot.com/api/v1/accounts/:account_id/conversations/:conversation_id/toggle_status", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The numeric ID of the account" }, { "name": "conversation_id", "value": "", "type": "path", "description": "The numeric ID of the conversation" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "api_access_token", "value": "{{api_access_token}}", "placement": "header" } }, "docs": "Toggle the status of a conversation. Pass `status` to explicitly set the\nconversation state. Use `snoozed` along with `snoozed_until` to snooze a\nconversation until a specific time. If `snoozed_until` is omitted, the\nconversation is snoozed until the next reply from the contact. Regardless\nof the value provided, snoozed conversations always reopen on the next\nreply from the contact." }, { "info": { "name": "Toggle Priority", "type": "http" }, "http": { "method": "POST", "url": "https://app.chatwoot.com/api/v1/accounts/:account_id/conversations/:conversation_id/toggle_priority", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The numeric ID of the account" }, { "name": "conversation_id", "value": "", "type": "path", "description": "The numeric ID of the conversation" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "api_access_token", "value": "{{api_access_token}}", "placement": "header" } }, "docs": "Toggles the priority of conversation" }, { "info": { "name": "Toggle Typing Status", "type": "http" }, "http": { "method": "POST", "url": "https://app.chatwoot.com/api/v1/accounts/:account_id/conversations/:conversation_id/toggle_typing_status", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The numeric ID of the account" }, { "name": "conversation_id", "value": "", "type": "path", "description": "The numeric ID of the conversation" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "api_access_token", "value": "{{api_access_token}}", "placement": "header" } }, "docs": "Toggles the typing status for a conversation." }, { "info": { "name": "Update Custom Attributes", "type": "http" }, "http": { "method": "POST", "url": "https://app.chatwoot.com/api/v1/accounts/:account_id/conversations/:conversation_id/custom_attributes", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The numeric ID of the account" }, { "name": "conversation_id", "value": "", "type": "path", "description": "The numeric ID of the conversation" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "api_access_token", "value": "{{api_access_token}}", "placement": "header" } }, "docs": "Updates the custom attributes of a conversation" }, { "info": { "name": "List Labels", "type": "http" }, "http": { "method": "GET", "url": "https://app.chatwoot.com/api/v1/accounts/:account_id/conversations/:conversation_id/labels", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The numeric ID of the account" }, { "name": "conversation_id", "value": "", "type": "path", "description": "The numeric ID of the conversation" } ], "auth": { "type": "apikey", "key": "api_access_token", "value": "{{api_access_token}}", "placement": "header" } }, "docs": "Lists all the labels of a conversation" }, { "info": { "name": "Add Labels", "type": "http" }, "http": { "method": "POST", "url": "https://app.chatwoot.com/api/v1/accounts/:account_id/conversations/:conversation_id/labels", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The numeric ID of the account" }, { "name": "conversation_id", "value": "", "type": "path", "description": "The numeric ID of the conversation" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "api_access_token", "value": "{{api_access_token}}", "placement": "header" } }, "docs": "Add labels to a conversation. Note that this API would overwrite the existing list of labels associated to the conversation." }, { "info": { "name": "Conversation Reporting Events", "type": "http" }, "http": { "method": "GET", "url": "https://app.chatwoot.com/api/v1/accounts/:account_id/conversations/:conversation_id/reporting_events", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The numeric ID of the account" }, { "name": "conversation_id", "value": "", "type": "path", "description": "The numeric ID of the conversation" } ], "auth": { "type": "apikey", "key": "api_access_token", "value": "{{api_access_token}}", "placement": "header" } }, "docs": "Get reporting events for a specific conversation. This endpoint returns events such as first response time, resolution time, and other metrics for the conversation, sorted by creation time in ascending order." } ] } ], "bundled": true }