ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Overview

This node operation allows you to add one or more agents (users) to an existing team within a specified account. It is useful in scenarios where you need to manage team memberships dynamically, such as onboarding new support agents into teams or reorganizing team structures programmatically.

Practical examples include:

  • Automatically adding newly hired support staff to their respective teams.
  • Bulk updating team memberships based on changes in organizational structure.
  • Integrating with HR or CRM systems to synchronize team assignments.

Properties

Name Meaning
Account Id The numeric ID of the account under which 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 (agents) 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 updated team membership or details about the added users. There is no indication that binary data is output by this node.

Dependencies

  • Requires an API key credential for authenticating requests to the ChatWoot API.
  • The base URL for the ChatWoot instance must be configured in the node credentials.
  • The node uses the ChatWoot REST API endpoint related to team management.

Troubleshooting

  • Invalid Account or Team ID: If the provided account or team ID does not exist or is incorrect, the API will likely return an error. Verify these IDs before running the node.
  • Malformed User IDs JSON: The User Ids property expects a valid JSON array of user IDs. Invalid JSON or incorrect formatting will cause parsing errors. Ensure the JSON is well-formed.
  • Authentication Errors: Missing or invalid API credentials will prevent the node from successfully communicating with the ChatWoot API. Confirm that the API key and base URL are correctly set.
  • Permission Issues: The API key used must have sufficient permissions to modify team memberships. Lack of permissions will result in authorization errors.

Links and References

Discussion