ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Inboxes → Delete Agent In Inbox

AI-generated

Overview

This node operation allows you to remove one or more agents (users) from a specific inbox within an account in the ChatWoot system. It is useful when managing team members who should no longer have access or responsibilities related to a particular inbox, such as when reassigning support duties or removing departed staff.

Practical examples:

  • Removing a support agent from a shared customer service inbox after they leave the team.
  • Updating inbox membership dynamically based on project assignments.
  • Cleaning up inbox user lists to maintain accurate access control.

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 node uses the ChatWoot API endpoint configured via credentials, including the base URL and authentication headers.
  • The operation sends a request to the ChatWoot API to modify inbox membership.

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 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 memberships.
  • API Rate Limits: If many requests are made in a short time, the API might throttle requests; handle retries accordingly.
  • Error Messages: Common error responses from the API include "Not Found" if the inbox or users do not exist, or "Unauthorized" if credentials are invalid.

Links and References

Discussion