ChatWoot icon

ChatWoot

Interact with ChatWoot API
Join our community

Actions113

Overview

This node updates an existing contact in a specified account within the ChatWoot system. It is useful for scenarios where you need to modify contact details such as name, email, phone number, avatar, or custom attributes programmatically. For example, you might use this node to synchronize updated customer information from your CRM into ChatWoot or to correct contact data based on user input.

Properties

Name Meaning
Account Id The numeric ID of the account where the contact exists (required).
Id The unique numeric ID of the contact to update (required).
Name The new or updated name of the contact.
Email The new or updated email address of the contact.
Phone Number The new or updated phone number of the contact.
Avatar Binary data or form data representing the contact's avatar image.
Avatar Url URL pointing to a JPEG or PNG file to be used as the contact's avatar image.
Identifier A unique identifier string for the contact in an external system.
Custom Attributes A JSON object containing custom key-value pairs to store additional attributes for the contact.

Output

The node outputs JSON data representing the updated contact object returned by the ChatWoot API. This typically includes all contact fields after the update, such as id, name, email, phone number, avatar URL, identifier, and any custom attributes. If binary data is involved (e.g., avatar image), it is sent as part of the request but not outputted as binary data from the node.

Dependencies

  • Requires an API key credential for authenticating with the ChatWoot API.
  • Needs the base URL of the ChatWoot instance configured in the credentials.
  • Depends on the ChatWoot REST API being accessible and operational.

Troubleshooting

  • Missing Required Fields: Ensure that both "Account Id" and "Id" of the contact are provided; otherwise, the API will reject the request.
  • Invalid JSON in Custom Attributes: The "Custom Attributes" field must be valid JSON. Invalid JSON will cause parsing errors.
  • Avatar Upload Issues: When sending avatar images, ensure the binary data is correctly attached or the avatar URL is reachable and points to a valid image.
  • API Authentication Errors: Verify that the API key credential is valid and has sufficient permissions to update contacts.
  • Network or API Errors: Check connectivity to the ChatWoot instance and confirm the API endpoint is correct.

Links and References

Discussion