Actions113
- Accounts Actions
- Account Users Actions
- Agent Bots Actions
- Users Actions
- Inbox API Actions
- Contacts API Actions
- Conversations API Actions
- Messages API Actions
- CSAT Survey Page Actions
- Account Agent Bots Actions
- Agents Actions
- Canned Responses Actions
- Canned Response Actions
- Custom Attributes Actions
- Contacts Actions
- Contact Actions
- Automation Rule Actions
- Help Center Actions
- Conversations Actions
- Conversation Assignment Actions
- Conversation Labels Actions
- Inboxes Actions
- Messages Actions
- Integrations Actions
- Webhooks Actions
- Teams Actions
- Custom Filters Actions
- Reports Actions
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 a shared inbox. For example, when onboarding new support agents or reallocating responsibilities, this operation helps update inbox memberships programmatically.
Properties
| Name | Meaning |
|---|---|
| Account Id | The numeric ID of the ChatWoot account that owns the inbox. |
| 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 the updated list of agents assigned to the inbox or error information if the operation failed.
No binary data output is involved in 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 configuration.
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 the request to fail.
- Authentication Errors: Ensure the API key/token is valid and has sufficient permissions to modify inbox memberships.
- Network Issues: Connectivity problems with the ChatWoot server will prevent successful execution.
Links and References
- ChatWoot API Documentation - Official API docs for reference on inbox and agent management endpoints.