ChatWoot

Interact with ChatWoot API

Actions117

Accounts Actions
- Create An Account
- Get Details Of An Account
- Delete An Account
- Update An Account
Account Users Actions
- List All Account Users
- Create An Account User
- Delete An Account User
Agent Bots Actions
- List All Agent Bots
- Create An Agent Bot
- Get Details Of A Single Agent Bot
- Delete An Agent Bot
- Update An Agent Bot
Users Actions
- Create A User
- Get Details Of A User
- Delete A User
- Update A User
- Get Sso Url Of A User
Inbox API Actions
- Get Details Of A Inbox
Contacts API Actions
- Create A Contact
- Get Details Of A Contact
- Update A Contact
Conversations API Actions
- List All Contact Conversations
- Create A Conversation
Messages API Actions
- List All Converation Messages
- Create A Message
- Update A Message
CSAT Survey Page Actions
- Get Csat Survey Page
Account Agent Bots Actions
- List All Account Agent Bots
- Create An Account Agent Bot
- Get Details Of A Single Account Agent Bot
- Delete An Account Agent Bot
- Update An Account Agent Bot
Agents Actions
- Get Account Agents
- Add New Agent To Account
- Delete Agent From Account
- Update Agent In Account
Canned Responses Actions
- Get Account Canned Response
- Add New Canned Response To Account
- Delete Canned Response From Account
Canned Response Actions
- Update Canned Response In Account
Custom Attributes Actions
- Get Account Custom Attribute
- Add New Custom Attribute To Account
- Get Details Of A Single Custom Attribute
- Delete Custom Attribute From Account
- Update Custom Attribute In Account
Contacts Actions
- Contact List
- Contact Create
- Contact Details
- Contact Update
- Contact Delete
- Contact Conversations
- Contact Search
- Contact Filter
Contact Actions
- Contact Inbox Creation
- Contactable Inboxes Get
Automation Rule Actions
- Get Account Automation Rule
- Add New Automation Rule To Account
- Get Details Of A Single Automation Rule
- Delete Automation Rule From Account
- Update Automation Rule In Account
Help Center Actions
- Get Portal
- Add New Portal To Account
- Update New Portal To Account
- Add New Category To Account
- Add New Article To Account
Conversations Actions
- Conversation List Meta
- Conversation List
- New Conversation
- Conversation Filter
- Get Details Of A Conversation
- Toggle Status Of A Conversation
- Toggle Priority Of A Conversation
Conversation Assignment Actions
- Assign A Conversation
Conversation Labels Actions
- List All Labels Of A Conversation
- Conversation Add Labels
Inboxes Actions
- List All Inboxes
- Get Inbox
- Inbox Creation
- Update Inbox
- Get Inbox Agent Bot
- Update Agent Bot
- Get Inbox Members
- Add New Agent To Inbox
- Delete Agent In Inbox
- Update Agents In Inbox
Messages Actions
- List All Messages
- Create A New Message In A Conversation
- Delete A Message
Integrations Actions
- Get Details Of All Integrations
- Create An Integration Hook
- Delete An Integration Hook
- Update An Integrations Hook
- Switch Active n8n Flow
Profile Actions
- Fetch Profile
N 8 N Actions
- Switch Active n8n Flow
Teams Actions
- List All Teams
- Create A Team
- Get Details Of A Single Team
- Delete A Team
- Update A Team
- Get Team Members
- Add New Agent To Team
- Delete Agent In Team
- Update Agents In Team
Custom Filters Actions
- List All Filters
- Create A Custom Filter
- Get Details Of A Single Custom Filter
- Delete A Custom Filter
- Update A Custom Filter
Webhooks Actions
- List All Webhooks
- Create A Webhook
- Delete A Webhook
- Update A Webhook
Reports Actions
- List All Conversation Statistics
- List All Conversation Statistics Summary
- Get Account Conversation Metrics
- Get Agent Conversation Metrics

Inboxes → Update Inbox

AI-generated

Summary

Update an existing inbox in a ChatWoot account by specifying the account ID and inbox ID along with optional properties to modify such as name, auto assignment setting, avatar image, and channel configuration.

Inputs

Account Id (required) — The numeric ID of the ChatWoot account containing the inbox.
Id (required) — The numeric ID of the inbox to update.
Name — The new name for the inbox.
Enable Auto Assignment (required) — Whether to enable or disable auto assignment of conversations in this inbox.
Avatar — Image file URL or data to update the inbox avatar.
Channel — JSON object representing the channel configuration for the inbox, parsed from string input.

Output shape

a single JSON object representing the updated inbox resource.

The operation sends an HTTP PATCH or PUT request to update the inbox and returns the updated inbox details in JSON format. Optional fields not provided will remain unchanged. Error responses follow standard API error formats.

Examples

Example 1: Update inbox to change its name and disable auto assignment

Provide the Account Id, the Inbox Id, set 'Name' to the desired new inbox name, and set 'Enable Auto Assignment' to false. Optional 'Avatar' and 'Channel' fields can be provided if necessary.

ChatWootInstall