ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions100

Overview

The Update Inbox operation for the Inboxes resource in this custom n8n node allows you to update the details of an existing inbox within your ChatWoot account. This is useful for managing support channels, updating their names, avatars, channel configurations, or toggling auto-assignment features. Typical scenarios include renaming an inbox, changing its avatar image, enabling/disabling automatic assignment of conversations, or updating channel-specific settings.

Practical Example:
You might use this node in a workflow that automatically updates the name and configuration of an inbox when a new team member joins, or when integrating with other systems that require dynamic management of support channels.


Properties

Display Name Type Description
Account Id Number The numeric ID of the ChatWoot account.
Id Number The unique identifier of the inbox to update.
Name String The new name for the inbox.
Enable Auto Assignment Boolean Whether to enable automatic assignment of conversations to agents.
Avatar String Image file (as a string) for the inbox avatar.
Channel JSON Channel-specific configuration as a JSON object.

Output

The node outputs a json field containing the updated inbox information as returned by the ChatWoot API. The structure typically includes:

{
  "id": 123,
  "name": "Support Inbox",
  "avatar": "https://example.com/avatar.png",
  "enable_auto_assignment": true,
  "channel": {
    // Channel-specific configuration
  },
  // ...other fields provided by the ChatWoot API
}
  • If the API returns additional fields, they will also be included in the output.
  • No binary data is produced by this operation.

Dependencies

  • External Service: Requires access to a ChatWoot instance.
  • API Key/Credentials: You must configure the chatwootApi credentials in n8n, including the base URL (url) and authentication token.
  • n8n Configuration: Ensure the node has access to the required credentials and that the ChatWoot API endpoint is reachable from your n8n instance.

Troubleshooting

Common Issues:

  • Invalid Account or Inbox ID: If the provided Account Id or Id does not exist, the API will return an error.
  • Authentication Errors: Missing or incorrect API credentials will result in authentication failures.
  • Malformed Channel JSON: If the Channel property is not valid JSON, the request may fail.
  • Missing Required Fields: Omitting required properties like Account Id or Id will cause the node to throw validation errors.

Error Messages & Resolutions:

  • "401 Unauthorized": Check your API credentials and ensure they are correctly configured in n8n.
  • "404 Not Found": Verify that the Account Id and Inbox Id correspond to existing resources in ChatWoot.
  • "400 Bad Request": Ensure all required fields are filled and that the Channel property contains valid JSON.

Links and References

Discussion