ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions117

Contacts API → Create A Contact

AI-generated

Summary

Create a new contact in a specified ChatWoot inbox using relevant contact details.

Inputs

  • Inbox Identifier (required) — The identifier obtained from API inbox channel to specify where the contact belongs.
  • Identifier — External identifier of the contact.
  • Identifier Hash — Identifier hash prepared for HMAC authentication.
  • Email — Email address of the contact.
  • Name — Name of the contact.
  • Phone Number — Phone number of the contact.
  • Avatar Url — URL to an image file (jpeg or png) for the contact's avatar.
  • Custom Attributes — Custom JSON attributes associated with the contact.

Output shape

a single JSON object representing the created contact.

The operation returns the created contact's details as a JSON object. Request options allow configuration of batching, SSL validation, proxy, and timeout settings.

Discussion