ChatWoot

Consume ChatWoot API

Actions11

Overview

This n8n node allows you to update (patch) a contact in Chatwoot, a customer engagement platform. It is useful for automating the process of modifying contact details—such as name, email, phone number, or custom attributes—directly from your workflows. Common scenarios include syncing user data from other systems, updating contact information after form submissions, or enriching contacts with additional metadata.

Example use cases:

Automatically update a contact's phone number when they change it in your CRM.
Add or modify custom attributes on a contact based on external triggers.
Patch contact records in bulk as part of a data migration or cleanup workflow.

Properties

Below are the input properties relevant for the Contact → Update | Patch operation:

Display Name	Type	Meaning
Authentication	options	Select how to authenticate: via direct parameters or predefined credentials.
BaseUrl	string	The base URL of your Chatwoot instance (required if using parameter-based authentication).
Access Token	string	Your Chatwoot API token (required if using parameter-based authentication).
Account ID	string	(Optional) Reference to a specific account; overrides credentials if provided.
Source ID	string	Internal source contact identifier, used for search; should be URL-escaped or HEX.
Contact ID	number (required)	The unique identifier of the contact to update.
Contact Identifier	string	(Optional) External API contact identifier.
Name	string	The new name for the contact.
Inbox ID	string	The inbox associated with the contact.
Phone Number	string	The contact's phone number.
E-Mail	string	The contact's email address.
Custom Attributes	fixedCollection	Key-value pairs for any custom attributes to set or update on the contact.

Output

The node returns a JSON object representing the updated contact. The structure typically includes:

{
  "id": 123,
  "name": "Updated Name",
  "email": "email@domain.com",
  "phone_number": "+1234567890",
  "inbox_id": "inbox_1",
  "custom_attributes": {
    "key1": "value1",
    "key2": "value2"
  },
  // ...other standard Chatwoot contact fields
}

If an error occurs and "Continue On Fail" is enabled, the output will contain an error field with the error message.

Dependencies

Chatwoot Instance: You must have access to a running Chatwoot server.
API Credentials: Either provide the BaseUrl and Access Token directly, or use predefined Chatwoot credentials configured in n8n.
n8n Configuration: If using predefined credentials, ensure they are set up under n8n’s credentials section.

Troubleshooting

Common Issues:

Invalid Credentials: If the BaseUrl or Access Token is incorrect, authentication will fail.
Missing Required Fields: Omitting required fields like Contact ID will result in errors.
Incorrect Field Values: Providing invalid values (e.g., non-numeric Contact ID) may cause the request to fail.

Error Messages:

"Authentication failed": Check your BaseUrl and Access Token or credential configuration.
"Contact not found": Ensure the Contact ID exists in your Chatwoot instance.
"Missing required property": Make sure all required fields are filled.

How to resolve:

Double-check your credentials and endpoint URLs.
Verify that the Contact ID corresponds to an existing contact.
Review the node’s required fields and ensure all are provided.