ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

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 managing team members who should no longer have access to handle conversations in a particular inbox, such as when an agent leaves the team or changes roles.

Practical examples:

  • Removing a support agent from the "Customer Support" inbox after they leave the company.
  • Cleaning up inbox assignments by deleting multiple users from an inbox that is being reassigned.
  • Automating user management workflows where inbox memberships are updated based on external HR systems.

Properties

Name Meaning
Account Id The numeric ID 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 the users (agents) to be deleted from the 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: Ensure that the provided Account Id and Inbox Id are correct and exist in your ChatWoot instance.
  • User IDs Format: The User Ids property must be a valid JSON array of numeric or string IDs. Malformed JSON or incorrect types may cause request failures.
  • Authentication Errors: Verify that the API key credential is valid and has sufficient permissions to modify inbox memberships.
  • API Rate Limits: If many requests are made in a short time, you might hit rate limits imposed by ChatWoot. Implement retries or backoff strategies if needed.
  • Error Messages: The node will relay error messages from the ChatWoot API, which can include reasons like "User not found in inbox" or "Permission denied." Review these messages to adjust inputs or credentials accordingly.

Links and References

Discussion