ChatWoot Client icon

ChatWoot Client

Interact with ChatWoot Client APIs

Contacts API → Create a Contact

AI-generated

Summary

Create a new contact in a specified ChatWoot inbox by sending contact details to the ChatWoot API endpoint.

Inputs

  • Additional Options — Optional fields to include in the request body to define the contact. This includes avatar (image binary or URL), custom attributes dynamically loaded from your ChatWoot account's custom attribute definitions, email, external identifier, identifier hash for HMAC authentication, name, and phone number.

Output shape

a single JSON object representing the created contact.

The operation sends a POST request to /public/api/v1/inboxes/{inboxIdentifier}/contacts endpoint. It uses the inboxIdentifier from credentials. The returned data contains the created contact details as provided by the ChatWoot API. Optional fields are merged into the request body if specified.

Examples

Example 1: Create contact with email and name

Set resource to 'Contacts API' and operation to 'Create a contact'. Provide 'Email' and 'Name' fields in 'Additional Options' to define the new contact.

Links

Discussion