ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Overview

This node operation allows you to create a new user within a specific account in the ChatWoot system. It is useful for managing team members by adding them as either administrators or agents to an account, enabling collaboration and role-based access control. For example, a support manager can add a new agent to handle customer conversations under a particular account.

Properties

Name Meaning
Account Id The numeric identifier of the account where the user will be added.
User Id The unique identifier of the user to be added to the account.
Role The role assigned to the user in the account; options typically include "administrator" or "agent".

Output

The output JSON contains the response from the ChatWoot API after creating the account user. This usually includes details about the newly created account-user relationship such as IDs, roles, timestamps, and status. There is no binary data output for this operation.

Dependencies

  • Requires an API key credential for authenticating with the ChatWoot API.
  • The base URL for the ChatWoot instance must be configured in the node credentials.
  • The node depends on the ChatWoot REST API endpoint that manages account users.

Troubleshooting

  • Invalid Account Id or User Id: If these IDs do not exist or are incorrect, the API will return an error. Verify the IDs before running the node.
  • Insufficient Permissions: The API key used must have permissions to manage account users; otherwise, authorization errors will occur.
  • Role Value Errors: Ensure the role value is valid (e.g., "administrator" or "agent"). Invalid roles may cause the request to fail.
  • Network or API Endpoint Issues: Check connectivity and the correctness of the base URL if requests time out or fail.

Links and References

Discussion