ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions117

Contacts API → Update A Contact

AI-generated

Summary

Update an existing contact's details in ChatWoot by specifying the inbox and contact identifiers along with any fields to change.

Inputs

  • Inbox Identifier (required) — The identifier of the inbox channel associated with the contact.
  • Contact Identifier (required) — The source ID of the contact to update, obtained when the contact was originally created.
  • Identifier — External identifier of the contact to update.
  • Identifier Hash — HMAC authentication hash corresponding to the identifier.
  • Email — New or updated email address for the contact.
  • Name — New or updated name of the contact.
  • Phone Number — New or updated phone number of the contact.
  • Avatar Url — URL pointing to an image file to use as the contact's avatar.
  • Custom Attributes — JSON object specifying custom attributes to associate with the contact.

Output shape

a single record representing the updated contact data

The response contains the updated contact information. The operation supports optional batching and request customization options such as proxy, timeout, and ignoring SSL certificate issues.

Examples

Example 1: Update contact email and name

Set Inbox Identifier and Contact Identifier with required strings; provide new Email and Name fields with desired values.

Discussion