ChatWoot

Interact with ChatWoot API

Actions113

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
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
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
- 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

Overview

This node operation allows you to remove one or more agents (users) from a specific inbox within an account in ChatWoot. It is useful for managing team members' access to customer conversations by revoking their permissions to participate in or view messages in that inbox.

Common scenarios include:

Removing agents who no longer handle conversations in a particular inbox.
Managing agent assignments dynamically based on workload or role changes.
Cleaning up inbox memberships when reorganizing teams.

For example, if an agent leaves the support team responsible for a product line, this operation can be used to delete their user ID from the corresponding inbox, ensuring they no longer receive notifications or have access.

Properties

Name	Meaning
Account Id	The numeric identifier of the ChatWoot account where the inbox exists.
Inbox Id	The unique identifier of the inbox from which agents will be removed.
User Ids	A JSON array containing the IDs of users (agents) to be deleted from the specified inbox.

Output

The node outputs JSON data representing the response from the ChatWoot API after attempting to delete the specified agents from the inbox. This typically includes confirmation of success or details about any errors encountered.

No binary data output is involved in this operation.

Dependencies

Requires an active connection to the ChatWoot API.
Needs an API authentication token configured in the node credentials to authorize requests.
The base URL for the ChatWoot instance must be set in the credentials.

Troubleshooting

Invalid Account or Inbox ID: If the provided account or inbox ID does not exist or is incorrect, the API will return an error. Verify these IDs before running the node.
User IDs Format: The User Ids property expects a valid JSON array of numeric or string IDs. Malformed JSON or invalid user IDs may cause request failures.
Authentication Errors: Ensure the API key credential is correctly configured and has sufficient permissions to modify inbox memberships.
Network Issues: Connectivity problems with the ChatWoot server will prevent successful execution.

Links and References

ChatWoot API Documentation - For detailed information on inbox and user management endpoints.
n8n Documentation - For guidance on setting up API credentials and using HTTP-based nodes.

ChatWootInstall