ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions100

Overview

The Contact Update operation for the Contacts resource in this custom n8n node allows you to update an existing contact's details within a ChatWoot account. This is useful for keeping your contact information synchronized between ChatWoot and other systems, such as CRMs or marketing platforms. For example, you might use this node to automatically update a contact's email address or add custom attributes when they change in your primary database.

Properties

Below are the supported input properties for the Contact Update operation:

Display Name Type Description
Account Id Number The numeric ID of the account. (Required)
Id Number ID of the contact to update. (Required)
Name String Name of the contact.
Email String Email address of the contact.
Phone Number String Phone number of the contact.
Avatar String Form data with the avatar image binary or use the avatar_url.
Avatar Url String URL to a JPEG or PNG file for the contact avatar.
Identifier String A unique identifier for the contact in an external system.
Custom Attributes JSON An object for storing custom attributes (e.g., {"type":"customer", "age":30}).

Output

The output will be a JSON object representing the updated contact. The structure typically includes fields such as:

{
  "id": 123,
  "name": "John Doe",
  "email": "john@example.com",
  "phone_number": "+1234567890",
  "avatar_url": "https://example.com/avatar.jpg",
  "identifier": "external-unique-id",
  "custom_attributes": {
    "type": "customer",
    "age": 30
  },
  ...
}

Additional fields may be present depending on the ChatWoot API response.

Dependencies

  • External Service: Requires access to a ChatWoot instance.
  • API Key/Credentials: You must configure the chatwootApi credential in n8n, which should include the base URL (url) and authentication details for your ChatWoot account.

Troubleshooting

  • Missing Required Fields: If Account Id or Id is missing, the node will fail to execute. Ensure these fields are always provided.
  • Invalid Credentials: Errors related to authentication (e.g., 401 Unauthorized) indicate issues with your ChatWoot credentials. Double-check your API key and base URL.
  • Malformed Custom Attributes: If the Custom Attributes field contains invalid JSON, the request will fail. Always provide valid JSON objects.
  • Network/Connection Issues: Timeouts or connection errors may occur if the ChatWoot server is unreachable.

Links and References

Discussion