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
- Teams Actions
- Custom Filters Actions
- Webhooks 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 in scenarios where you need to manage team members' access to customer conversations by revoking their permissions to participate in or monitor a particular inbox.
Practical examples include:
- Removing agents who have left the support team from the shared inbox.
- Adjusting team assignments dynamically based on workload or role changes.
- Automating cleanup of user access when onboarding or offboarding staff.
Properties
| Name | Meaning |
|---|---|
| Account Id | The numeric identifier of the ChatWoot account that owns the inbox. |
| 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 result of the delete operation. This typically includes confirmation of the removal or details about the updated inbox state. No binary data output is involved.
Dependencies
- Requires an API key credential for authenticating with the ChatWoot API.
- The base URL for the ChatWoot instance must be configured in the node credentials.
- The node depends on the ChatWoot REST API endpoint for managing inbox agents.
Troubleshooting
- Invalid Account or Inbox ID: Ensure that the provided account and inbox IDs are correct and exist in your ChatWoot instance.
- User IDs Format: The
user_idsproperty must be a valid JSON array of numeric or string IDs. Malformed JSON or incorrect types may cause errors. - Authentication Errors: Verify that the API key credential is valid and has sufficient permissions to modify inbox agents.
- API Endpoint Issues: Network problems or incorrect base URL configuration can lead to request failures. Confirm connectivity and URL correctness.
Common error messages might include unauthorized access, resource not found, or bad request due to invalid parameters. Resolving these involves checking credentials, input values, and API endpoint configurations.