Actions113
- Accounts Actions
- Account Users Actions
- Agent Bots Actions
- Users Actions
- Inbox API Actions
- Contacts API Actions
- Conversations API Actions
- Messages API Actions
- CSAT Survey Page Actions
- Account Agent Bots Actions
- Agents Actions
- Canned Responses Actions
- Canned Response Actions
- Custom Attributes Actions
- Contacts Actions
- Contact Actions
- Automation Rule Actions
- Help Center Actions
- Conversations Actions
- Conversation Assignment Actions
- Conversation Labels Actions
- Inboxes Actions
- Messages Actions
- Integrations Actions
- Webhooks Actions
- Teams Actions
- Custom Filters Actions
- Reports Actions
Overview
This node operation allows you to remove one or more agents (users) from a specific inbox within an account on the ChatWoot platform. It is useful when you want to revoke access or remove agents who should no longer handle conversations in that inbox.
Common scenarios include:
- Managing team members dynamically by removing agents who have left a project or changed roles.
- Cleaning up inbox assignments to ensure only relevant agents have access.
- Automating user management workflows in customer support setups.
For example, if you have an inbox dedicated to a product support channel and an agent leaves the team, you can use this operation to delete their access from that inbox programmatically.
Properties
| Name | Meaning |
|---|---|
| Account Id | The numeric ID 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 output of this node operation typically contains a JSON object reflecting the result of the deletion request. This may include confirmation of successful removal or details about any errors encountered.
No binary data is output by this operation.
Dependencies
- Requires an API key credential for authenticating with the ChatWoot API.
- The node expects the base URL of the ChatWoot instance to be configured in the credentials.
- Network connectivity to the ChatWoot API endpoint is necessary.
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: Ensure the
User Idsproperty is a valid JSON array of numeric or string IDs. Malformed JSON or invalid user IDs will cause the request to fail. - Authentication Errors: Missing or invalid API credentials will prevent the node from executing successfully. Confirm that the API key and base URL are correctly set.
- Permission Issues: The authenticated user must have sufficient permissions to modify inbox agents. Lack of permissions will result in authorization errors.
Links and References
- ChatWoot API Documentation - For detailed information on API endpoints and payloads.
- ChatWoot Official Website