ChatWoot Client icon

ChatWoot Client

Interact with ChatWoot Client APIs

Contacts API → Update a Contact

AI-generated

Summary

Update an existing contact in a specified inbox by providing the contact's identifier and optionally modifying attributes such as name, email, phone number, avatar, custom attributes, and authentication hashes.

Inputs

  • Contact Identifier Name or ID (required) — The unique identifier of the contact to update within the inbox. Can be selected from a list or specified via an expression.
  • Avatar — The new avatar image binary or URL to set for the contact.
  • Custom Attributes — Custom attributes for the contact; supports adding multiple predefined custom fields.
  • Email — The updated email address of the contact.
  • Identifier — An external identifier to associate with the contact.
  • Identifier Hash — A hash for the identifier, used for HMAC authentication.
  • Name — The updated name of the contact.
  • Phone Number — The updated phone number of the contact.

Output shape

a JSON object representing the updated contact's data as returned from the ChatWoot API

The response contains the updated contact details from the PATCH request to the ChatWoot API endpoint /public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}.

Links

Discussion