ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

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 associated with an inbox to match updated branding.
  • Enabling or disabling automatic assignment of conversations to agents.
  • Updating the channel configuration JSON to integrate with different messaging platforms.

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 to use as the inbox avatar.
Channel JSON object representing the channel configuration details (e.g., platform-specific data).

Output

The node outputs JSON data representing the updated inbox object returned by the ChatWoot API. This typically includes all the inbox properties after the update, such as the updated name, avatar URL, auto-assignment status, and channel configuration.

If the API supports it, binary data output is not indicated for this operation.

Dependencies

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

Troubleshooting

  • Invalid Account or Inbox ID: If the provided account or inbox ID does not exist, the API will return an error. Verify that these IDs are correct.
  • Authentication Errors: Missing or invalid API credentials will cause authorization failures. Ensure the API key/token is valid and has sufficient permissions.
  • Malformed Channel JSON: The channel property expects valid JSON. Invalid JSON syntax will cause parsing errors. Use proper JSON formatting.
  • Missing Required Fields: The account_id, id, and enable_auto_assignment fields are required. Omitting them will result in validation errors.
  • API Rate Limits: Frequent updates may hit rate limits imposed by ChatWoot. Implement retry logic or reduce request frequency if needed.

Links and References

Discussion