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 after receiving new input.

Properties

Name Meaning
Account Id The numeric ID of the account to which the contact belongs (required).
Id The unique numeric ID of the contact to update (required).
Name The contact's name.
Email The contact's email address.
Phone Number The contact's phone number.
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.
Identifier A unique identifier for the contact in an external system.
Custom Attributes A JSON object containing custom key-value pairs to store additional attributes for the contact. Example: {"type":"customer", "age":30}

Output

The node outputs JSON data representing the updated contact object as returned by the ChatWoot API. This typically includes all contact fields such as id, name, email, phone number, avatar URLs, identifiers, and any custom attributes. If the avatar is updated via binary data, the node handles sending that appropriately but does not output binary data itself.

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

  • Common issues:
    • Invalid or missing account ID or contact ID will cause the update to fail.
    • Providing malformed JSON in the custom attributes field can result in parsing errors.
    • Network connectivity problems or incorrect API credentials will prevent successful API calls.
  • Error messages:
    • Authentication errors indicate invalid or missing API credentials; verify and update them.
    • Validation errors from the API usually specify which required fields are missing or incorrectly formatted.
    • JSON parse errors for custom attributes suggest the input is not valid JSON; ensure proper formatting.

Links and References

Discussion