ChatWoot icon

ChatWoot

Consume ChatWoot API

Contact → Create

AI-generated

Summary

Create a contact in Chatwoot

Inputs

  • authentication (required) — Select credential type: Parameters (requires BaseUrl + Access Token) or Predefined Chatwoot Credentials (BaseUrl + Token)
  • baseUrl (required) — Base URL for the Chatwoot instance (e.g., https://chatwoot.org). Shown when authentication = Parameters.
  • accessToken (required) — API token for authentication. Overrides credentials if provided. Shown when authentication = Parameters, or resource = account/contact.
  • accountId — Account ID reference. Overrides credentials if provided.
  • sourceId — Internal source contact identifier, URL escaped or HEX.
  • contactIdentifier — External API contact identifier.
  • name — Contact name.
  • inboxId — Inbox ID.
  • phoneNumber — Phone number.
  • email — E-Mail address. Placeholder: email@domain.com
  • customAttributes — Custom key-value attributes. Multiple values allowed.

Output shape

Chatwoot API response representing the created contact

Returns the contact object as created by the Chatwoot API.

Examples

Example 1: Create a contact with name, email, and custom attributes using parameter credentials.

authentication = parametersCredentialType, baseUrl = https://my-chatwoot.example, accessToken = 00000000-0000-0000-0000-000000000000, name = John Doe, email = john@example.com, customAttributes = [{key: 'company', value: 'Acme'}]

Links

Discussion