ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Inboxes → Update Inbox

AI-generated

Overview

This node updates an existing inbox in a ChatWoot account. It is useful for managing communication channels by modifying inbox details such as the name, avatar image, auto-assignment settings, and channel configuration. Typical use cases include renaming an inbox to reflect new team structures, changing the avatar to match branding updates, enabling or disabling automatic assignment of conversations, or updating channel-specific settings.

For example, a customer support manager might use this node to rename an inbox from "Support Team A" to "Priority Support" and enable auto-assignment to ensure incoming messages are distributed automatically among agents.

Properties

Name Meaning
Account Id The numeric ID of the ChatWoot account where the inbox exists.
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 path to an image file to set as the inbox avatar.
Channel JSON object representing channel-specific configuration details for the inbox.

Output

The node outputs JSON data representing the updated inbox object as returned by the ChatWoot API. This typically includes fields such as the inbox ID, name, avatar URL, auto-assignment status, and channel configuration. The output can be used downstream to confirm the update or trigger further automation based on the updated inbox details.

No binary data output is involved.

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 provided in the credentials.

Troubleshooting

  • Invalid Account or Inbox ID: If the provided account or inbox ID does not exist, the API will return an error. Verify IDs before running the node.
  • Authentication Errors: Missing or invalid API credentials will cause authorization failures. Ensure the API key/token is correctly configured.
  • Malformed Channel JSON: The channel property expects valid JSON. Invalid JSON syntax will cause parsing errors. Use proper JSON formatting.
  • Empty Required Fields: Omitting required fields like account_id, id, or enable_auto_assignment will result in validation errors. Make sure all required inputs are provided.

Links and References

Discussion