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 inbox in the ChatWoot system. It allows users to modify various properties of an inbox such as its name, avatar image, channel configuration, and auto-assignment settings. This is useful for managing communication channels dynamically, for example, when rebranding a support team or changing how incoming messages are routed.
Practical examples include:
- Renaming an inbox to reflect a new product line.
- Changing the avatar image to match updated branding.
- Enabling or disabling automatic assignment of conversations to agents.
- Updating channel-specific settings like integration details.
Properties
| Name | Meaning |
|---|---|
| Account Id | The numeric ID of the account to which the inbox belongs. |
| Id | The unique numeric ID of the inbox to update. |
| Name | The new name for the inbox. |
| Enable Auto Assignment | Boolean flag to enable or disable automatic assignment of conversations to agents. |
| Avatar | URL or identifier of the image file used as the inbox avatar. |
| Channel | JSON object representing channel-specific configuration details (e.g., integration info). |
Output
The node outputs JSON data representing the updated inbox object returned by the ChatWoot API. This typically includes all current properties of the inbox after the update, such as its ID, name, avatar URL, auto-assignment status, and channel configuration.
No binary data output is indicated.
Dependencies
- Requires an API key credential for authenticating with the ChatWoot API.
- Needs the base URL of the ChatWoot instance configured in credentials.
- Depends on the ChatWoot REST API being accessible and operational.
Troubleshooting
- Common issues:
- Invalid or missing account or inbox IDs will cause errors.
- Incorrectly formatted JSON in the "Channel" property may lead to parsing failures.
- Insufficient permissions or invalid API credentials can result in authorization errors.
- Error messages:
- "Inbox not found" indicates the provided inbox ID does not exist under the specified account.
- "Unauthorized" or "Authentication failed" suggests problems with the API key or credentials.
- "Invalid JSON" points to malformed input in the channel configuration field.
- Resolutions:
- Verify that the account and inbox IDs are correct and exist.
- Ensure the API key credential is valid and has necessary permissions.
- Validate JSON syntax before submitting the channel property.