Actions113
- Contacts Actions
- Contact Actions
- Automation Rule Actions
- Help Center Actions
- Conversations Actions
- Conversation Assignment Actions
- Conversation Labels Actions
- Inboxes Actions
- Messages Actions
- Integrations Actions
- Teams Actions
- Custom Filters Actions
- Webhooks Actions
- Reports Actions
- Accounts Actions
- Account Users Actions
- Agent Bots Actions
- Users Actions
- Contacts API Actions
- Inbox API Actions
- Conversations API Actions
- Messages API Actions
- CSAT Survey Page Actions
- Account Agent Bots Actions
- Agents Actions
- Canned Responses Actions
- Custom Attributes Actions
- Canned Response Actions
Overview
This node operation updates an existing agent within a specified account in the ChatWoot system. It allows modifying key attributes of the agent such as their role (agent or administrator), availability status, and whether they automatically go offline when away. This is useful for managing support team members dynamically, ensuring their status and permissions are up to date without manual intervention in the ChatWoot dashboard.
Practical examples:
- Automatically setting an agent’s availability to "busy" during peak hours.
- Changing an agent’s role from "agent" to "administrator" when promoted.
- Disabling auto offline for agents who need to remain visible even when inactive.
Properties
| Name | Meaning |
|---|---|
| Account Id | The numeric ID of the account where the agent exists. |
| Id | The unique identifier of the agent to be updated. |
| Role | The role assigned to the agent; options are Agent or Administrator. |
| Availability | The current availability status of the agent; options are Available, Busy, or Offline. |
| Auto Offline | Boolean flag indicating if the agent should automatically switch to offline when away. |
Output
The node outputs JSON data representing the updated agent object as returned by the ChatWoot API. This typically includes the agent's updated details such as id, role, availability, and other metadata. There is no binary output.
Dependencies
- Requires an active connection to the ChatWoot API.
- Needs an API authentication token configured in the node credentials.
- The base URL for the ChatWoot instance must be set in the credentials.
Troubleshooting
- Invalid Account Id or Agent Id: Ensure that the provided numeric IDs correspond to existing entities in ChatWoot.
- Authentication errors: Verify that the API key/token is valid and has sufficient permissions to update agents.
- Invalid property values: Confirm that the role and availability values are among the allowed options.
- Network issues: Check connectivity to the ChatWoot server and correct base URL configuration.
Links and References
- ChatWoot API Documentation (for detailed API endpoints and payloads)
- ChatWoot Official Website