ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions117

Contacts → Contact Update

AI-generated

Summary

Update an existing contact within a specified ChatWoot account by providing the contact's ID and the account ID, along with optional updated fields such as name, email, phone number, avatar, avatar URL, identifier, and custom attributes.

Inputs

  • Account Id (required) — The numeric ID of the ChatWoot account where the contact exists.
  • Id (required) — The numeric ID of the contact to update.
  • Name — The new name for the contact.
  • Email — The new email address of the contact.
  • Phone Number — The new phone number of the contact.
  • Avatar — The avatar image data to update for the contact (can be sent as form data).
  • Avatar Url — A URL linking to the avatar image (JPEG or PNG) for the contact.
  • Identifier — A unique external identifier for the contact.
  • Custom Attributes — A JSON object specifying custom attributes for the contact, for example {"type":"customer", "age":30}.

Output shape

a single record representing the updated contact information as returned by the ChatWoot API

The returned data reflects the updated contact fields. Request supports optional batching and proxy configurations as node-level request options. Errors and unexpected responses depend on ChatWoot API behavior.

Examples

Example 1: Update contact's email and phone number

Specify account_id and id of the contact, provide new email and phone_number values.

Discussion