# Chatwoot Developer Docs

> Official developer documentation for Chatwoot - the open-source customer support platform. Learn about our APIs, integrations, and development guidelines.

- [Welcome to Chatwoot Developer Docs](https://developers.chatwoot.com/introduction.md): Your comprehensive guide to installing, configuring, developing with, and integrating Chatwoot - the open-source customer support platform.
- [Chatwoot CLI](https://developers.chatwoot.com/cli.md): Install and configure the Chatwoot CLI to manage your inbox from the terminal.
- [CLI Commands](https://developers.chatwoot.com/cli/commands.md): Learn the Chatwoot CLI command grammar and commonly used commands.
- [CLI Scripting](https://developers.chatwoot.com/cli/scripting.md): Use Chatwoot CLI output formats and shell recipes to automate support workflows.
- [Agent skill](https://developers.chatwoot.com/cli/agent-skill.md): Install the Chatwoot CLI agent skill so coding tools like Claude Code, Cursor, and Codex can use chatwoot effectively.
- [Self-Hosted Installation Guide](https://developers.chatwoot.com/self-hosted.md): Complete guide to install and setup a production-ready Chatwoot instance on your own infrastructure.
- [Chatwoot Production Deployment Guide](https://developers.chatwoot.com/self-hosted/deployment/architecture.md): Understanding Chatwoot's production architecture and deployment requirements
- [System Requirements](https://developers.chatwoot.com/self-hosted/deployment/requirements.md): Hardware and software requirements for self-hosting Chatwoot
- [Production deployment guide for Linux VM](https://developers.chatwoot.com/self-hosted/deployment/linux-vm.md): Deploy Chatwoot on Ubuntu 24.04 LTS using the automated installation script
- [Docker Chatwoot Production deployment guide](https://developers.chatwoot.com/self-hosted/deployment/docker.md): Deploy Chatwoot using Docker containers for production environments
- [Deploy Chatwoot on Kubernetes using Helm Charts](https://developers.chatwoot.com/self-hosted/deployment/helm-chart.md): Deploy Chatwoot on Kubernetes using our official Helm charts
- [Chatwoot CTL](https://developers.chatwoot.com/self-hosted/deployment/chatwoot-ctl.md): CLI tool to install and manage a self hosted Chatwoot Linux installation
- [AWS Chatwoot deployment guide](https://developers.chatwoot.com/self-hosted/deployment/aws.md): Deploy Chatwoot on AWS with a reference HA architecture
- [AWS Marketplace AMI Deployment](https://developers.chatwoot.com/self-hosted/deployment/aws-marketplace.md): Deploy Chatwoot on AWS using the marketplace AMI listing
- [Azure Chatwoot deployment guide](https://developers.chatwoot.com/self-hosted/deployment/azure.md): Deploy Chatwoot on a single VM in Azure
- [DigitalOcean Chatwoot deployment guide](https://developers.chatwoot.com/self-hosted/deployment/digitalocean.md): Deploy Chatwoot on a single droplet in DigitalOcean
- [GCP Chatwoot deployment guide](https://developers.chatwoot.com/self-hosted/deployment/gcp.md): Deploy Chatwoot on a single VM in GCP
- [Heroku Chatwoot Production Deployment Guide](https://developers.chatwoot.com/self-hosted/deployment/heroku.md): Deploy Chatwoot on Heroku with one-click deployment
- [Caprover Chatwoot Production deployment guide](https://developers.chatwoot.com/self-hosted/deployment/caprover.md): Deploy Chatwoot using Caprover's one-click application management
- [Deploy Chatwoot to Clever Cloud](https://developers.chatwoot.com/self-hosted/deployment/clevercloud.md): Deploy Chatwoot on Clever Cloud PaaS platform
- [Cloudron Chatwoot deployment guide](https://developers.chatwoot.com/self-hosted/deployment/cloudron.md): Deploy Chatwoot using Cloudron's 1-click app platform
- [Restack Chatwoot production deployment guide](https://developers.chatwoot.com/self-hosted/deployment/restack.md): Deploy Chatwoot on AWS with Restack's managed Kubernetes platform
- [Deploying Chatwoot on Easypanel](https://developers.chatwoot.com/self-hosted/deployment/easypanel.md): Deploy Chatwoot using Easypanel's modern server control panel
- [Elestio Chatwoot fully managed deployment guide](https://developers.chatwoot.com/self-hosted/deployment/elestio.md): Deploy Chatwoot with Elestio's fully managed platform
- [Environment Variables](https://developers.chatwoot.com/self-hosted/configuration/environment-variables.md): Complete reference for Chatwoot environment variables and configuration options
- [MFA Setup Guide](https://developers.chatwoot.com/self-hosted/configuration/multi-factor-authentication.md)
- [Optimizing Configurations](https://developers.chatwoot.com/self-hosted/deployment/performance/optimizing-configurations.md): Performance optimization guide for Chatwoot self-hosted deployments
- [Cloudfront CDN](https://developers.chatwoot.com/self-hosted/deployment/performance/cloudfront-cdn.md): Configure Cloudfront as a CDN for Chatwoot assets
- [Super Admin Console](https://developers.chatwoot.com/self-hosted/monitoring/super-admin-sidekiq.md): Guide to accessing and using the Super Admin Console and Sidekiq monitoring
- [APM and Tracing](https://developers.chatwoot.com/self-hosted/monitoring/apm-and-error-monitoring.md): Configure APM and error monitoring tools for Chatwoot
- [Rate Limiting](https://developers.chatwoot.com/self-hosted/monitoring/rate-limiting.md): Configure rate limiting to protect your Chatwoot installation from abuse
- [Supported Providers](https://developers.chatwoot.com/self-hosted/deployment/storage/supported-providers.md): Configure cloud storage providers for Chatwoot file storage
- [S3 Bucket](https://developers.chatwoot.com/self-hosted/deployment/storage/s3-bucket.md): Configure Amazon S3 bucket as storage in Chatwoot
- [GCS Bucket](https://developers.chatwoot.com/self-hosted/deployment/storage/gcs-bucket.md): Configure Google Cloud Storage bucket as storage in Chatwoot
- [Introduction to Email Channel Configuration](https://developers.chatwoot.com/self-hosted/configuration/features/email-channel/introduction.md): Overview of email channel configuration for self-hosted Chatwoot
- [Google Workspace](https://developers.chatwoot.com/self-hosted/configuration/features/email-channel/google-workspace-setup.md): Configure an OAuth app for Gmail
- [Outlook & Microsoft 365 Email](https://developers.chatwoot.com/self-hosted/configuration/features/email-channel/azure-app-setup.md): Configure an OAuth app for Outlook & Microsoft 365 emails
- [Forwarding Emails to Chatwoot](https://developers.chatwoot.com/self-hosted/configuration/features/email-channel/forwarding-emails-to-chatwoot.md): Guide to set up email forwarding to Chatwoot
- [Configuring inbound mails in Chatwoot](https://developers.chatwoot.com/self-hosted/configuration/features/email-channel/ingress-providers.md): Guide to set up inbound emails in Chatwoot
- [Conversation Continuity](https://developers.chatwoot.com/self-hosted/configuration/features/email-channel/conversation-continuity.md): Continue conversations between website live chat and email
- [SendGrid Guide](https://developers.chatwoot.com/self-hosted/configuration/features/email-channel/conversation-continuity-using-sendgrid.md): Guide to setting up Conversation Continuity with SendGrid
- [Configuring Amazon SES as an Ingress Provider for Chatwoot](https://developers.chatwoot.com/self-hosted/configuration/features/email-channel/amazon-ses-ingress.md): Guide to setting up conversation continuity, inbound emails with Amazon SES
- [Help Center](https://developers.chatwoot.com/self-hosted/configuration/help-center.md): Set up a public-facing help center portal with custom domain and SSL certificate
- [Setting Up Facebook](https://developers.chatwoot.com/self-hosted/configuration/features/integrations/facebook-channel-setup.md): Configure Facebook Messenger integration for Chatwoot
- [Instagram via Facebook Login](https://developers.chatwoot.com/self-hosted/configuration/features/integrations/instagram-channel-setup.md): Set up Instagram integration using Facebook Login authentication
- [Set up Instagram Business Login for Chatwoot](https://developers.chatwoot.com/self-hosted/configuration/features/integrations/instagram-via-instagram-business-login.md): Configure the Chatwoot Instagram integration for a self-hosted installation using Meta's recommended Instagram Business Login flow.
- [WhatsApp Embedded Signup](https://developers.chatwoot.com/self-hosted/configuration/features/integrations/whatsapp-embedded-signup.md): Set up WhatsApp integration using Meta's streamlined embedded signup flow
- [Setting Up Slack Integration](https://developers.chatwoot.com/self-hosted/configuration/features/integrations/slack-integration-setup.md): Configure Slack integration to receive Chatwoot conversations in Slack channels
- [Setting Up Linear Integration](https://developers.chatwoot.com/self-hosted/configuration/features/integrations/linear-integration-setup.md): Configure Linear integration to track issues and features from Chatwoot
- [Setting Up Shopify Integration](https://developers.chatwoot.com/self-hosted/configuration/features/integrations/shopify-integration-setup.md): Configure Shopify integration to track orders and customer information from Chatwoot
- [Setting Up TikTok Channel](https://developers.chatwoot.com/self-hosted/configuration/features/integrations/tiktok.md): Configure TikTok Business Messaging integration to manage TikTok conversations from Chatwoot
- [Upgrading your Chatwoot installation](https://developers.chatwoot.com/self-hosted/deployment/upgrade.md): Step-by-step guide to upgrade Chatwoot across different deployment methods
- [Backing Up Your Chatwoot Installation](https://developers.chatwoot.com/self-hosted/deployment/backup.md): Complete guide to backing up and restoring your Chatwoot installation data
- [How to migrate Chatwoot database?](https://developers.chatwoot.com/self-hosted/runbooks/migrate-chatwoot-database.md): Learn how to migrate your Chatwoot database from bundled PostgreSQL to managed database services like AWS RDS
- [How to upgrade to Chatwoot v4?](https://developers.chatwoot.com/self-hosted/runbooks/upgrade-to-chatwoot-v4.md): Complete guide for upgrading to Chatwoot v4 with PostgreSQL pgvector support
- [Customize email notifications in Chatwoot](https://developers.chatwoot.com/self-hosted/runbooks/email-notifications.md): Guide to customizing email notification templates in self-hosted Chatwoot installations
- [How to enable IP identification in Chatwoot?](https://developers.chatwoot.com/self-hosted/runbooks/enable-ip-logging.md): Guide to enabling IP address geocoding and location identification in Chatwoot
- [Telemetry](https://developers.chatwoot.com/self-hosted/telemetry.md): Learn about Chatwoot's telemetry data collection, what data is collected, how it's used, and how to opt-out
- [Managing Enterprise Edition Features](https://developers.chatwoot.com/self-hosted/enterprise-edition.md): Learn how to manage and configure Chatwoot Enterprise Edition features including licensing, pricing, and advanced capabilities
- [Supported Features on Channels](https://developers.chatwoot.com/self-hosted/supported-features.md): Comprehensive reference for supported features, message types, and limitations across all Chatwoot channels
- [Message Statuses](https://developers.chatwoot.com/self-hosted/message-statuses.md): Understand what each message status means in Chatwoot and which channels support delivery and read indicators.
- [Running Chatwoot in Restricted Instances](https://developers.chatwoot.com/self-hosted/restricted-instances.md): Configuration guide for deploying Chatwoot in environments with restricted internal networks
- [Instagram App Review](https://developers.chatwoot.com/self-hosted/instagram-app-review.md): Complete guide for submitting Instagram App Review request to get advanced messaging permissions for Chatwoot integration
- [Frequently Asked Questions](https://developers.chatwoot.com/self-hosted/faq.md): Common questions and answers about self-hosted Chatwoot installation, support, and best practices
- [Custom Mobile App Build](https://developers.chatwoot.com/self-hosted/custom-mobile-app.md): Guide to building a custom-branded Chatwoot mobile app with push notifications and deep linking
- [Contributing to Chatwoot](https://developers.chatwoot.com/contributing-guide.md): Complete guide to contributing to Chatwoot - from setting up your development environment to submitting pull requests.
- [macOS Development Setup](https://developers.chatwoot.com/contributing-guide/environment-setup/mac-os.md): Complete guide to setting up your macOS development environment for Chatwoot contribution.
- [Ubuntu Development Setup](https://developers.chatwoot.com/contributing-guide/environment-setup/ubuntu.md): Complete guide to setting up your Ubuntu development environment for Chatwoot contribution.
- [Windows Development Setup](https://developers.chatwoot.com/contributing-guide/environment-setup/windows.md): Complete guide to setting up your Windows development environment for Chatwoot contribution using WSL2.
- [Docker Development Setup](https://developers.chatwoot.com/contributing-guide/environment-setup/docker.md): Complete guide to setting up Chatwoot development environment using Docker and Docker Compose.
- [Make Commands Setup](https://developers.chatwoot.com/contributing-guide/environment-setup/make.md): Speed up your local development workflow with Make commands for Chatwoot.
- [Project Setup Guide](https://developers.chatwoot.com/contributing-guide/setup-guide.md): Complete guide to setting up and running Chatwoot in development mode
- [Environment Variables for Development](https://developers.chatwoot.com/contributing-guide/environment-variables.md): Complete guide to environment variables for Chatwoot development and testing
- [Common Errors and Solutions](https://developers.chatwoot.com/contributing-guide/common-errors.md): Troubleshooting guide for common errors during Chatwoot development setup
- [Telegram App Integration Setup](https://developers.chatwoot.com/contributing-guide/telegram-channel-setup.md): Setup Telegram app integration on your local machine for development
- [Line App Integration Setup](https://developers.chatwoot.com/contributing-guide/line-channel-setup.md): Setup Line app integration on your local machine for development
- [Mobile App Development Setup](https://developers.chatwoot.com/contributing-guide/mobile-app/setup-guide.md): Setup guide for Chatwoot mobile app development
- [End-to-end testing with Cypress](https://developers.chatwoot.com/contributing-guide/tests/cypress.md): Guide to running Cypress end-to-end tests for Chatwoot
- [Chatwoot APIs](https://developers.chatwoot.com/contributing-guide/chatwoot-apis.md)
- [API Documentation](https://developers.chatwoot.com/contributing-guide/api-documentation.md)
- [Chatwoot Platform APIs](https://developers.chatwoot.com/contributing-guide/chatwoot-platform-apis.md)
- [Reporting Security Issues](https://developers.chatwoot.com/contributing-guide/security-reports.md): How to report security vulnerabilities in Chatwoot
- [Translate Chatwoot to Your Language](https://developers.chatwoot.com/contributing-guide/translation-guidelines.md): Guide to translating Chatwoot using Crowdin translation platform
- [Chatwoot Community Guidelines](https://developers.chatwoot.com/contributing-guide/community-guidelines.md): Guidelines for participating in the Chatwoot community across all platforms
- [Contributor Covenant Code of Conduct](https://developers.chatwoot.com/contributing-guide/code-of-conduct.md): Code of conduct for Chatwoot community members and contributors
- [Contributors](https://developers.chatwoot.com/contributing-guide/contributors.md): Meet the amazing people who contribute to Chatwoot
- [Introduction to Chatwoot APIs](https://developers.chatwoot.com/api-reference/introduction.md): Learn how to use Chatwoot APIs to build integrations, customize chat experiences, and manage your installation.
- [Get account details](https://developers.chatwoot.com/api-reference/account/get-account-details.md): Get the details of the current account
- [Update account](https://developers.chatwoot.com/api-reference/account/update-account.md): Update account details, settings, and custom attributes
- [List Audit Logs in Account](https://developers.chatwoot.com/api-reference/audit-logs/list-audit-logs-in-account.md): Get Details of Audit Log entries for an Account. This endpoint is only available in Enterprise editions and requires the audit_logs feature to be enabled.
- [List all AgentBots](https://developers.chatwoot.com/api-reference/account-agentbots/list-all-agentbots.md): List all agent bots available for the current account
- [Create an Agent Bot](https://developers.chatwoot.com/api-reference/account-agentbots/create-an-agent-bot.md): Create an agent bot in the account
- [Get an agent bot details](https://developers.chatwoot.com/api-reference/account-agentbots/get-an-agent-bot-details.md): Get the details of an agent bot in the account
- [Delete an AgentBot](https://developers.chatwoot.com/api-reference/account-agentbots/delete-an-agentbot.md): Delete an AgentBot from the account
- [Update an agent bot](https://developers.chatwoot.com/api-reference/account-agentbots/update-an-agent-bot.md): Update an agent bot's attributes
- [List Agents in Account](https://developers.chatwoot.com/api-reference/agents/list-agents-in-account.md): Get Details of Agents in an Account
- [Add a New Agent](https://developers.chatwoot.com/api-reference/agents/add-a-new-agent.md): Add a new Agent to Account
- [Remove an Agent from Account](https://developers.chatwoot.com/api-reference/agents/remove-an-agent-from-account.md): Remove an Agent from Account
- [Update Agent in Account](https://developers.chatwoot.com/api-reference/agents/update-agent-in-account.md): Update an Agent in Account
- [List all Canned Responses in an Account](https://developers.chatwoot.com/api-reference/canned-responses/list-all-canned-responses-in-an-account.md): Get Details of Canned Responses in an Account
- [Add a New Canned Response](https://developers.chatwoot.com/api-reference/canned-responses/add-a-new-canned-response.md): Add a new Canned Response to Account
- [Remove a Canned Response from Account](https://developers.chatwoot.com/api-reference/canned-responses/remove-a-canned-response-from-account.md): Remove a Canned Response from Account
- [Update Canned Response in Account](https://developers.chatwoot.com/api-reference/canned-responses/update-canned-response-in-account.md): Update a Canned Response in Account
- [List all custom attributes in an account](https://developers.chatwoot.com/api-reference/custom-attributes/list-all-custom-attributes-in-an-account.md): Get details of custom attributes in an Account
- [Add a new custom attribute](https://developers.chatwoot.com/api-reference/custom-attributes/add-a-new-custom-attribute.md): Add a new custom attribute to account
- [Get a custom attribute details](https://developers.chatwoot.com/api-reference/custom-attributes/get-a-custom-attribute-details.md): Get the details of a custom attribute in the account
- [Remove a custom attribute from account](https://developers.chatwoot.com/api-reference/custom-attributes/remove-a-custom-attribute-from-account.md): Remove a custom attribute from account
- [Update custom attribute in Account](https://developers.chatwoot.com/api-reference/custom-attributes/update-custom-attribute-in-account.md): Update a custom attribute in account
- [List Contacts](https://developers.chatwoot.com/api-reference/contacts/list-contacts.md): Listing all the resolved contacts with pagination (Page size = 15). Resolved contacts are the ones with a value for identifier, email or phone number
- [Create Contact](https://developers.chatwoot.com/api-reference/contacts/create-contact.md): Create a new Contact
- [Show Contact](https://developers.chatwoot.com/api-reference/contacts/show-contact.md): Get a contact belonging to the account using ID
- [Update Contact](https://developers.chatwoot.com/api-reference/contacts/update-contact.md): Update a contact belonging to the account using ID
- [Delete Contact](https://developers.chatwoot.com/api-reference/contacts/delete-contact.md): Delete a contact belonging to the account using ID
- [Contact Conversations](https://developers.chatwoot.com/api-reference/contacts/contact-conversations.md): Get conversations associated with that contact
- [Search Contacts](https://developers.chatwoot.com/api-reference/contacts/search-contacts.md): Search the resolved contacts using a search key, currently supports email search (Page size = 15). Resolved contacts are the ones with a value for identifier, email or phone number
- [Contact Filter](https://developers.chatwoot.com/api-reference/contacts/contact-filter.md): Filter contacts with custom filter options and pagination
- [Create contact inbox](https://developers.chatwoot.com/api-reference/contacts/create-contact-inbox.md): Create a contact inbox record for an inbox
- [Get Contactable Inboxes](https://developers.chatwoot.com/api-reference/contacts/get-contactable-inboxes.md): Get List of contactable Inboxes
- [Merge Contacts](https://developers.chatwoot.com/api-reference/contacts/merge-contacts.md): Merge two contacts into a single contact. The base contact remains and receives all data from the mergee contact. After the merge, the mergee contact is permanently deleted.
- [List Labels](https://developers.chatwoot.com/api-reference/contact-labels/list-labels.md): Lists all the labels of a contact
- [Add Labels](https://developers.chatwoot.com/api-reference/contact-labels/add-labels.md): Add labels to a contact. Note that this API would overwrite the existing list of labels associated to the conversation.
- [List all automation rules in an account](https://developers.chatwoot.com/api-reference/automation-rule/list-all-automation-rules-in-an-account.md): Get details of automation rules in an Account
- [Add a new automation rule](https://developers.chatwoot.com/api-reference/automation-rule/add-a-new-automation-rule.md): Add a new automation rule to account
- [Get a automation rule details](https://developers.chatwoot.com/api-reference/automation-rule/get-a-automation-rule-details.md): Get the details of a automation rule in the account
- [Remove a automation rule from account](https://developers.chatwoot.com/api-reference/automation-rule/remove-a-automation-rule-from-account.md): Remove a automation rule from account
- [Update automation rule in Account](https://developers.chatwoot.com/api-reference/automation-rule/update-automation-rule-in-account.md): Update a automation rule in account
- [List all portals in an account](https://developers.chatwoot.com/api-reference/help-center/list-all-portals-in-an-account.md): Get details of portals in an Account
- [Add a new portal](https://developers.chatwoot.com/api-reference/help-center/add-a-new-portal.md): Add a new portal to account
- [Get a portal details](https://developers.chatwoot.com/api-reference/help-center/get-a-portal-details.md): Get the details of a portal in the account
- [Update a portal](https://developers.chatwoot.com/api-reference/help-center/update-a-portal.md): Update a portal to account
- [Add a new category](https://developers.chatwoot.com/api-reference/help-center/add-a-new-category.md): Add a new category to portal
- [Add a new article](https://developers.chatwoot.com/api-reference/help-center/add-a-new-article.md): Add a new article to portal
- [Get Conversation Counts](https://developers.chatwoot.com/api-reference/conversations/get-conversation-counts.md): Get open, unassigned and all Conversation counts
- [Conversations List](https://developers.chatwoot.com/api-reference/conversations/conversations-list.md): List all the conversations with pagination
- [Create New Conversation](https://developers.chatwoot.com/api-reference/conversations/create-new-conversation.md): Creating a conversation in chatwoot requires a source id.
- [Conversations Filter](https://developers.chatwoot.com/api-reference/conversations/conversations-filter.md): Filter conversations with custom filter options and pagination
- [Conversation Details](https://developers.chatwoot.com/api-reference/conversations/conversation-details.md): Get all details regarding a conversation with all messages in the conversation
- [Update Conversation](https://developers.chatwoot.com/api-reference/conversations/update-conversation.md): Update Conversation Attributes
- [Toggle Status](https://developers.chatwoot.com/api-reference/conversations/toggle-status.md): Toggle the status of a conversation. Pass `status` to explicitly set the conversation state. Use `snoozed` along with `snoozed_until` to snooze a conversation until a specific time. If `snoozed_until` is omitted, the conversation is snoozed until the next reply from the contact. Regardless of the va…
- [Toggle Priority](https://developers.chatwoot.com/api-reference/conversations/toggle-priority.md): Toggles the priority of conversation
- [Toggle Typing Status](https://developers.chatwoot.com/api-reference/conversations/toggle-typing-status.md): Toggles the typing status for a conversation.
- [Update Last Seen](https://developers.chatwoot.com/api-reference/conversations/update-last-seen.md): Updates the last seen of the conversation so that conversations will have the bubbles in the agents screen
- [Update Custom Attributes](https://developers.chatwoot.com/api-reference/conversations/update-custom-attributes.md): Updates the custom attributes of a conversation
- [Destroy Custom Attributes](https://developers.chatwoot.com/api-reference/conversations/destroy-custom-attributes.md): Removes the given custom attribute keys from a conversation
- [List Labels](https://developers.chatwoot.com/api-reference/conversations/list-labels.md): Lists all the labels of a conversation
- [Add Labels](https://developers.chatwoot.com/api-reference/conversations/add-labels.md): Add labels to a conversation. Note that this API would overwrite the existing list of labels associated to the conversation.
- [Conversation Reporting Events](https://developers.chatwoot.com/api-reference/conversations/conversation-reporting-events.md): 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.
- [Assign Conversation](https://developers.chatwoot.com/api-reference/conversation-assignments/assign-conversation.md): Assign a conversation to an agent or a team
- [Get account branded email layout](https://developers.chatwoot.com/api-reference/inboxes/get-account-branded-email-layout.md): Get the account-scoped Liquid HTML layout used as the fallback for branded email replies.
- [Update account branded email layout](https://developers.chatwoot.com/api-reference/inboxes/update-account-branded-email-layout.md): Update or clear the account-scoped Liquid HTML layout used as the fallback for branded email replies.
- [List all inboxes](https://developers.chatwoot.com/api-reference/inboxes/list-all-inboxes.md): List all inboxes available in the current account
- [Create an inbox](https://developers.chatwoot.com/api-reference/inboxes/create-an-inbox.md): You can create more than one website inbox in each account
- [Get an inbox](https://developers.chatwoot.com/api-reference/inboxes/get-an-inbox.md): Get an inbox available in the current account
- [Update Inbox](https://developers.chatwoot.com/api-reference/inboxes/update-inbox.md): Update an existing inbox
- [List WhatsApp message templates](https://developers.chatwoot.com/api-reference/inboxes/list-whatsapp-message-templates.md): List the cached message templates available for a native or Twilio WhatsApp inbox
- [Show Inbox Agent Bot](https://developers.chatwoot.com/api-reference/inboxes/show-inbox-agent-bot.md): See if an agent bot is associated to the Inbox
- [Add or remove agent bot](https://developers.chatwoot.com/api-reference/inboxes/add-or-remove-agent-bot.md): To add an agent bot pass agent_bot id, to remove agent bot from an inbox pass null
- [List Agents in Inbox](https://developers.chatwoot.com/api-reference/inboxes/list-agents-in-inbox.md): Get Details of Agents in an Inbox
- [Add a New Agent](https://developers.chatwoot.com/api-reference/inboxes/add-a-new-agent.md): Add a new Agent to Inbox
- [Remove an Agent from Inbox](https://developers.chatwoot.com/api-reference/inboxes/remove-an-agent-from-inbox.md): Remove an Agent from Inbox
- [Update Agents in Inbox](https://developers.chatwoot.com/api-reference/inboxes/update-agents-in-inbox.md): All agents except the one passed in params will be removed
- [List all labels](https://developers.chatwoot.com/api-reference/labels/list-all-labels.md): List all labels available in the current account
- [Create a label](https://developers.chatwoot.com/api-reference/labels/create-a-label.md): Create a label in the account
- [Get a label](https://developers.chatwoot.com/api-reference/labels/get-a-label.md): Get the details of a label in the account
- [Delete a label](https://developers.chatwoot.com/api-reference/labels/delete-a-label.md): Delete a label from the account
- [Update a label](https://developers.chatwoot.com/api-reference/labels/update-a-label.md): Update a label's attributes
- [Get messages](https://developers.chatwoot.com/api-reference/messages/get-messages.md): List all messages of a conversation
- [Create New Message](https://developers.chatwoot.com/api-reference/messages/create-new-message.md): Create a new message in the conversation.
- [Delete a message](https://developers.chatwoot.com/api-reference/messages/delete-a-message.md): Delete a message and it's attachments from the conversation.
- [Update message status](https://developers.chatwoot.com/api-reference/messages/update-message-status.md): Updates the delivery status of a single message. Available only for messages in API channel inboxes, where your own system is responsible for delivering messages and reporting what happened. Use this to push `sent`, `delivered`, and `read` receipts into Chatwoot, for example, to mark an agent's mess…
- [List all the Integrations](https://developers.chatwoot.com/api-reference/integrations/list-all-the-integrations.md): Get the details of all Integrations available for the account
- [Create an integration hook](https://developers.chatwoot.com/api-reference/integrations/create-an-integration-hook.md): Create an integration hook
- [Delete an Integration Hook](https://developers.chatwoot.com/api-reference/integrations/delete-an-integration-hook.md): Delete an Integration Hook
- [Update an Integration Hook](https://developers.chatwoot.com/api-reference/integrations/update-an-integration-hook.md): Update an Integration Hook
- [Fetch user profile](https://developers.chatwoot.com/api-reference/profile/fetch-user-profile.md): Get the user profile details
- [Update user profile](https://developers.chatwoot.com/api-reference/profile/update-user-profile.md): Update the user profile details
- [List all teams](https://developers.chatwoot.com/api-reference/teams/list-all-teams.md): List all teams available in the current account
- [Create a team](https://developers.chatwoot.com/api-reference/teams/create-a-team.md): Create a team in the account
- [Get a team details](https://developers.chatwoot.com/api-reference/teams/get-a-team-details.md): Get the details of a team in the account
- [Delete a team](https://developers.chatwoot.com/api-reference/teams/delete-a-team.md): Delete a team from the account
- [Update a team](https://developers.chatwoot.com/api-reference/teams/update-a-team.md): Update a team's attributes
- [List Agents in Team](https://developers.chatwoot.com/api-reference/teams/list-agents-in-team.md): Get Details of Agents in an Team
- [Add a New Agent](https://developers.chatwoot.com/api-reference/teams/add-a-new-agent.md): Add a new Agent to Team
- [Remove an Agent from Team](https://developers.chatwoot.com/api-reference/teams/remove-an-agent-from-team.md): Remove an Agent from Team
- [Update Agents in Team](https://developers.chatwoot.com/api-reference/teams/update-agents-in-team.md): All agents except the one passed in params will be removed
- [List all custom filters](https://developers.chatwoot.com/api-reference/custom-filters/list-all-custom-filters.md): List all custom filters in a category of a user
- [Create a custom filter](https://developers.chatwoot.com/api-reference/custom-filters/create-a-custom-filter.md): Create a custom filter in the account
- [Get a custom filter details](https://developers.chatwoot.com/api-reference/custom-filters/get-a-custom-filter-details.md): Get the details of a custom filter in the account
- [Delete a custom filter](https://developers.chatwoot.com/api-reference/custom-filters/delete-a-custom-filter.md): Delete a custom filter from the account
- [Update a custom filter](https://developers.chatwoot.com/api-reference/custom-filters/update-a-custom-filter.md): Update a custom filter's attributes
- [List all webhooks](https://developers.chatwoot.com/api-reference/webhooks/list-all-webhooks.md): List all webhooks in the account
- [Add a webhook](https://developers.chatwoot.com/api-reference/webhooks/add-a-webhook.md): Add a webhook subscription to the account
- [Delete a webhook](https://developers.chatwoot.com/api-reference/webhooks/delete-a-webhook.md): Delete a webhook from the account
- [Update a webhook object](https://developers.chatwoot.com/api-reference/webhooks/update-a-webhook-object.md): Update a webhook object in the account
- [Account Reporting Events](https://developers.chatwoot.com/api-reference/reports/account-reporting-events.md): Get paginated reporting events for the account. This endpoint returns reporting events such as first response time, resolution time, and other metrics. Only administrators can access this endpoint. Results are paginated with 25 items per page.
- [Get Account reports](https://developers.chatwoot.com/api-reference/reports/get-account-reports.md): Get Account reports for a specific type, metric and date range
- [Get Account reports summary](https://developers.chatwoot.com/api-reference/reports/get-account-reports-summary.md): Get Account reports summary for a specific type and date range
- [Account Conversation Metrics](https://developers.chatwoot.com/api-reference/reports/account-conversation-metrics.md): Get conversation metrics for Account
- [Agent Conversation Metrics](https://developers.chatwoot.com/api-reference/reports/agent-conversation-metrics.md): Get conversation metrics for Agent
- [Get conversation statistics grouped by channel type](https://developers.chatwoot.com/api-reference/reports/get-conversation-statistics-grouped-by-channel-type.md): Get conversation counts grouped by channel type and status for a given date range. Returns statistics for each channel type including open, resolved, pending, snoozed, and total conversation counts.
- [Get conversation statistics grouped by inbox](https://developers.chatwoot.com/api-reference/reports/get-conversation-statistics-grouped-by-inbox.md): Get conversation statistics grouped by inbox for a given date range. Returns metrics for each inbox including conversation counts, resolution counts, average first response time, average resolution time, and average reply time.
- [Get conversation statistics grouped by agent](https://developers.chatwoot.com/api-reference/reports/get-conversation-statistics-grouped-by-agent.md): Get conversation statistics grouped by agent for a given date range. Returns metrics for each agent including conversation counts, resolution counts, average first response time, average resolution time, and average reply time.
- [Get conversation statistics grouped by team](https://developers.chatwoot.com/api-reference/reports/get-conversation-statistics-grouped-by-team.md): Get conversation statistics grouped by team for a given date range. Returns metrics for each team including conversation counts, resolution counts, average first response time, average resolution time, and average reply time.
- [Get first response time distribution by channel](https://developers.chatwoot.com/api-reference/reports/get-first-response-time-distribution-by-channel.md): Get the distribution of first response times grouped by channel type. Returns conversation counts in different time buckets (0-1h, 1-4h, 4-8h, 8-24h, 24h+) for each channel type.
- [Get inbox-label matrix report](https://developers.chatwoot.com/api-reference/reports/get-inbox-label-matrix-report.md): Get a matrix showing the count of conversations for each inbox-label combination. Returns a list of inboxes, labels, and a 2D matrix where each cell contains the count of conversations in a specific inbox that have a specific label applied.
- [Get outgoing messages count grouped by entity](https://developers.chatwoot.com/api-reference/reports/get-outgoing-messages-count-grouped-by-entity.md): Get the count of outgoing messages grouped by a specified entity (agent, team, inbox, or label). When grouped by agent, messages sent by bots (AgentBot, Captain::Assistant) are excluded.
- [List campaigns](https://developers.chatwoot.com/api-reference/campaigns/list-campaigns.md): List all campaigns in the account. The response is an unpaginated array. Requires an account administrator and API access enabled for the account.
- [Create a campaign](https://developers.chatwoot.com/api-reference/campaigns/create-a-campaign.md): Create a campaign. For a supported messaging inbox, provide scheduled_at to schedule a one-off campaign; omitting it makes the campaign eligible for the next scheduler run. Website campaigns use trigger_rules instead. Channel-specific campaign availability and requirements still apply. One-off campa…
- [Get a campaign](https://developers.chatwoot.com/api-reference/campaigns/get-a-campaign.md): Retrieve a campaign using its account-scoped ID. Requires an account administrator and API access enabled for the account.
- [Delete a campaign](https://developers.chatwoot.com/api-reference/campaigns/delete-a-campaign.md): Delete a campaign from the account. Requires an account administrator and API access enabled for the account.
- [Update a campaign](https://developers.chatwoot.com/api-reference/campaigns/update-a-campaign.md): Update campaign fields, including scheduled_at to reschedule an active one-off campaign. Completed campaigns cannot be updated. Requires an account administrator and API access enabled for the account.
- [Create an Account](https://developers.chatwoot.com/api-reference/accounts/create-an-account.md): Create an Account
- [Get an account details](https://developers.chatwoot.com/api-reference/accounts/get-an-account-details.md): Get the details of an account
- [Delete an Account](https://developers.chatwoot.com/api-reference/accounts/delete-an-account.md): Delete an Account
- [Update an account](https://developers.chatwoot.com/api-reference/accounts/update-an-account.md): Update an account's attributes
- [List all Account Users](https://developers.chatwoot.com/api-reference/account-users/list-all-account-users.md): List all account users
- [Create an Account User](https://developers.chatwoot.com/api-reference/account-users/create-an-account-user.md): Create an Account User
- [Delete an Account User](https://developers.chatwoot.com/api-reference/account-users/delete-an-account-user.md): Delete an Account User
- [List all AgentBots](https://developers.chatwoot.com/api-reference/agentbots/list-all-agentbots.md): List all agent bots available
- [Create an Agent Bot](https://developers.chatwoot.com/api-reference/agentbots/create-an-agent-bot.md): Create an agent bot
- [Get an agent bot details](https://developers.chatwoot.com/api-reference/agentbots/get-an-agent-bot-details.md): Get the details of an agent bot
- [Delete an AgentBot](https://developers.chatwoot.com/api-reference/agentbots/delete-an-agentbot.md): Delete an AgentBot
- [Update an agent bot](https://developers.chatwoot.com/api-reference/agentbots/update-an-agent-bot.md): Update an agent bot's attributes
- [Create a User](https://developers.chatwoot.com/api-reference/users/create-a-user.md): Create a User
- [Get an user details](https://developers.chatwoot.com/api-reference/users/get-an-user-details.md): Get the details of an user
- [Delete a User](https://developers.chatwoot.com/api-reference/users/delete-a-user.md): Delete a User
- [Update a user](https://developers.chatwoot.com/api-reference/users/update-a-user.md): Update a user's attributes
- [Get User SSO Link](https://developers.chatwoot.com/api-reference/users/get-user-sso-link.md): Get the sso link of a user
- [Get User Access Token](https://developers.chatwoot.com/api-reference/users/get-user-access-token.md): Get the access token of a user
- [Create a contact](https://developers.chatwoot.com/api-reference/contacts-api/create-a-contact.md): Create a contact
- [Get a contact](https://developers.chatwoot.com/api-reference/contacts-api/get-a-contact.md): Get the details of a contact
- [Update a contact](https://developers.chatwoot.com/api-reference/contacts-api/update-a-contact.md): Update a contact's attributes
- [List all conversations](https://developers.chatwoot.com/api-reference/conversations-api/list-all-conversations.md): List all conversations for the contact
- [Create a conversation](https://developers.chatwoot.com/api-reference/conversations-api/create-a-conversation.md): Create a conversation
- [Get a single conversation](https://developers.chatwoot.com/api-reference/conversations-api/get-a-single-conversation.md): Retrieves the details of a specific conversation
- [Resolve a conversation](https://developers.chatwoot.com/api-reference/conversations-api/resolve-a-conversation.md): Marks a conversation as resolved
- [Toggle typing status](https://developers.chatwoot.com/api-reference/conversations-api/toggle-typing-status.md): Toggles the typing status in a conversation
- [Update last seen and mark messages read](https://developers.chatwoot.com/api-reference/conversations-api/update-last-seen-and-mark-messages-read.md): Updates the contact's last seen time for the conversation and marks agent messages sent before that time as read. Use this to send read receipts from a custom client built on the API channel, so agents can see when the contact has read their messages.
- [List all messages](https://developers.chatwoot.com/api-reference/messages-api/list-all-messages.md): List all messages in the conversation
- [Create a message](https://developers.chatwoot.com/api-reference/messages-api/create-a-message.md): Create a message
- [Update a message](https://developers.chatwoot.com/api-reference/messages-api/update-a-message.md): Update a message
- [Get CSAT survey page](https://developers.chatwoot.com/api-reference/csat-survey-page/get-csat-survey-page.md): You can redirect the client to this URL, instead of implementing the CSAT survey component yourself.

## OpenAPI Specs

- [application_swagger](https://raw.githubusercontent.com/chatwoot/chatwoot/develop/swagger/tag_groups/application_swagger.json)
- [client_swagger](https://raw.githubusercontent.com/chatwoot/chatwoot/develop/swagger/tag_groups/client_swagger.json)
- [other_swagger](https://raw.githubusercontent.com/chatwoot/chatwoot/develop/swagger/tag_groups/other_swagger.json)
- [platform_swagger](https://raw.githubusercontent.com/chatwoot/chatwoot/develop/swagger/tag_groups/platform_swagger.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.