ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Teams → Add New Agent To Team

AI-generated

Overview

This node operation allows you to add one or more agents (users) to an existing team within a specified account in the ChatWoot system. It is useful for managing team memberships dynamically, such as when onboarding new support agents or reorganizing teams.

Practical examples:

  • Adding newly hired customer support agents to a specific team.
  • Assigning multiple users to a team responsible for handling a particular product or service.
  • Automating team updates based on changes in organizational structure.

Properties

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

Output

The node outputs JSON data representing the result of the API call to add agents to the team. This typically includes confirmation of the update and details about the team membership after the addition. 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.
  • Proper permissions are needed on the API key to modify 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. Invalid JSON syntax will cause parsing errors. Ensure the input is correctly formatted.
  • Insufficient Permissions: If the API key lacks permission to modify teams, the request will fail. Check API key scopes and permissions.
  • Network or Authentication Errors: Common HTTP errors like 401 Unauthorized or 403 Forbidden indicate issues with authentication or access rights. Confirm that the API key and base URL are correct.

Links and References

Discussion