ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Inboxes → Add New Agent To Inbox

AI-generated

Overview

This node operation allows you to add one or more agents (users) to a specific inbox within an account on the ChatWoot platform. It is useful for managing team members who can access and respond to conversations in that inbox. For example, when onboarding new support agents or redistributing workload among teams, this operation helps programmatically update inbox memberships.

Properties

Name Meaning
Account Id The numeric identifier of the ChatWoot account where the inbox exists.
Inbox Id The unique identifier of the inbox to which agents will be added.
User Ids A JSON array containing the IDs of users (agents) to be added to the specified inbox.

Output

The node outputs JSON data representing the response from the ChatWoot API after attempting to add the specified agents to the inbox. This typically includes confirmation details such as updated inbox membership information or status messages. There is no binary output associated with this operation.

Dependencies

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

Troubleshooting

  • Invalid Account or Inbox ID: If the provided account or inbox 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 must be provided as a valid JSON array. Malformed JSON or invalid user IDs will cause request failures.
  • Authentication Errors: Ensure the API key credential is correctly configured and has sufficient permissions to modify inbox memberships.
  • Network Issues: Connectivity problems with the ChatWoot server will prevent successful execution.

Links and References

Discussion