ChatWoot icon

ChatWoot

Interact with ChatWoot API
Join our community

Actions113

Overview

This node operation allows you to remove one or more agents (users) from a specific team within an account on the ChatWoot platform. It is useful for managing team membership dynamically, such as when agents leave a team or need to be reassigned. For example, if a support team is reorganized and certain agents should no longer have access to that team's conversations, this operation can be used to delete those agents from the team.

Properties

Name Meaning
Account Id The numeric ID of the account where the team exists.
Team Id The numeric ID of the team from which agents will be removed.
User Ids A JSON array containing the IDs of users (agents) to be deleted from the specified team.

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. The exact structure depends on the API response but generally includes status information and possibly the updated team data.

No binary data output is expected from this operation.

Dependencies

  • Requires an API key credential for authenticating with the ChatWoot API.
  • The node uses the base URL provided in the credentials to send requests.
  • The operation sends a JSON body containing user IDs to the ChatWoot API endpoint responsible for managing team memberships.

Troubleshooting

  • Invalid Account or Team ID: If the provided account or team ID does not exist or is incorrect, the API will return an error. Verify these IDs before running the node.
  • Malformed User IDs JSON: The User Ids property expects a valid JSON array. Ensure the input is correctly formatted JSON; otherwise, parsing errors will occur.
  • Authentication Errors: Missing or invalid API credentials will cause authentication failures. Confirm that the API key is correctly configured in the node credentials.
  • Permission Issues: The API user must have sufficient permissions to modify team memberships. Lack of permissions will result in authorization errors.
  • Empty User IDs Array: Sending an empty array might either do nothing or cause an error depending on the API behavior. Make sure to provide at least one user ID.

Links and References

Discussion