ChatWoot Application icon

ChatWoot Application

Interact with ChatWoot Application APIs

Actions112

Contact → Create Contact

AI-generated

Summary

Create a new contact in ChatWoot within a specified account and inbox, optionally including additional details such as name, email, phone number, avatar, and custom attributes.

Inputs

  • Account ID (required) — Numeric ID of the ChatWoot account where the contact will be created.
  • Inbox ID (required) — ID of the inbox to which the contact belongs.
  • Name — Name of the contact.
  • Email — Email address of the contact.
  • Phone Number — Phone number of the contact.
  • Identifier — Unique identifier for the contact in an external system.
  • Blocked — Boolean flag to mark the contact as blocked or not.
  • Avatar — Binary data of the avatar image to upload for the contact.
  • Avatar Url — URL to an image file to use as the contact's avatar.
  • Custom Attributes — Object storing custom attribute values matching defined custom attribute schema for this contact.
  • Additional Attributes — Arbitrary JSON object for storing additional contact attributes.

Output shape

single record representing the created contact

The output includes the full contact object as returned by the ChatWoot API after creation. Returned data depends on provided input fields and server response.

Links

Discussion