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
- Teams Actions
- Custom Filters Actions
- Webhooks Actions
- Reports 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 that their permissions and availability reflect current operational needs.
Practical examples include:
- Changing an agent’s role from a regular agent to an administrator to grant higher privileges.
- Updating an agent’s availability status to "busy" during peak hours.
- Configuring auto-offline settings to ensure agents are marked offline automatically 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, Offline. |
| Auto Offline | Boolean flag indicating if the agent should automatically be set 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 confirming the successful update.
No binary data output is involved in 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 being accessible and the user having sufficient permissions to update agents.
Troubleshooting
- Invalid Account or Agent ID: If the provided account or agent ID does not exist, the API will return an error. Verify IDs before running the node.
- Insufficient Permissions: Attempting to update an agent without proper authorization may result in permission errors. Ensure the API key has adequate rights.
- Invalid Property Values: Providing unsupported values for role or availability will cause validation errors. Use only the allowed options.
- Network Issues: Connectivity problems with the ChatWoot server can cause request failures. Check network access and endpoint URL configuration.