ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Teams → Delete Agent In Team

AI-generated

Overview

This node operation allows you to remove one or more agents (users) from a specific team within an account. It is useful in scenarios where team membership needs to be updated dynamically, such as when agents leave a team, change roles, or are reassigned. For example, if you manage customer support teams and want to revoke access for certain agents from a team, this operation facilitates that by deleting their association with the team.

Properties

Name Meaning
Account Id The numeric identifier of the account that owns the team.
Team Id The numeric identifier 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 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 confirms which user IDs were removed from the team.

No binary data output is expected from this operation.

Dependencies

  • Requires an active connection to the ChatWoot API.
  • An API authentication token or key must be configured in the node credentials to authorize requests.
  • The base URL for the ChatWoot instance must be set in the credentials configuration.

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.
  • User IDs Format: The User Ids property expects a valid JSON array of numeric user IDs. Malformed JSON or invalid user IDs will cause the request to fail.
  • Authorization Errors: Ensure that the API key or token has sufficient permissions to modify team memberships.
  • Network Issues: Connectivity problems with the ChatWoot server can cause timeouts or failures. Check network settings and API availability.

Links and References

Discussion