ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Contacts API → Update A Contact

AI-generated

Overview

This node allows updating a contact in the Contacts API of ChatWoot. It is useful for scenarios where you need to modify existing contact information such as email, name, phone number, avatar URL, or custom attributes. For example, if a customer changes their email address or phone number, this node can update those details in the system to keep contact records current.

Properties

Name Meaning
Inbox Identifier The identifier obtained from the API inbox channel, used to specify which inbox the contact belongs to.
Contact Identifier The unique source ID of the contact obtained when the contact was created.
Identifier External identifier of the contact (optional).
Identifier Hash Identifier hash prepared for HMAC authentication (optional).
Email Email address of the contact (optional).
Name Name of the contact (optional).
Phone Number Phone number of the contact (optional).
Avatar Url URL to a JPEG or PNG file to set as the user's avatar (optional).
Custom Attributes JSON object containing custom attributes of the contact (optional).

Output

The node outputs JSON data representing the updated contact information as returned by the ChatWoot API. This typically includes all the contact fields after the update operation. There is no binary output.

Dependencies

  • Requires an API key credential for authenticating with the ChatWoot API.
  • The base URL for the ChatWoot instance must be configured in the credentials.
  • The node uses standard HTTP headers for JSON content type and expects JSON responses.

Troubleshooting

  • Missing Required Fields: Ensure that both "Inbox Identifier" and "Contact Identifier" are provided; these are mandatory.
  • Invalid Identifiers: If the identifiers do not match existing records, the API may return errors indicating the contact or inbox was not found.
  • Malformed JSON in Custom Attributes: The "Custom Attributes" field expects valid JSON. Invalid JSON will cause parsing errors.
  • Authentication Errors: Verify that the API key credential is correctly set up and has sufficient permissions.
  • Network Issues: Check connectivity to the ChatWoot instance URL configured in credentials.

Links and References

Discussion