Chatwoot icon

Chatwoot

Interact with Chatwoot API to manage conversations, messages, contacts, and more

Actions206

Contact → Create

AI-generated

Summary

Create a new contact in Chatwoot with specified details including name and optional fields like email, phone number, identifier, inbox association, and custom attributes.

Inputs

  • Name (required) — Full name of the contact to create.
  • Email — Email address of the contact.
  • Identifier — A unique external identifier for the contact from your system (e.g., user ID).
  • Inbox ID — The numeric ID of the inbox to associate the contact with. Obtainable from Chatwoot Settings → Inboxes.
  • Phone Number — Contact's phone number including country code (e.g., +1234567890).
  • Custom Attributes — JSON object containing custom attributes to assign to the contact, such as {"plan": "premium", "company": "Acme Inc"}.

Output shape

A JSON object representing the newly created contact with details assigned as per input.

The response object includes the created contact's properties. No pagination applies as this operation creates a single resource. Errors returned conform to Chatwoot API standards.

Examples

Example 1: Create a contact named 'John Doe' with email and custom attributes.

Set Name to 'John Doe', Email to 'john@example.com', Custom Attributes to '{"plan":"premium"}'.

Links

Discussion