ContactCreate

Payload to create or update a contact. The server normalizes the contact value (e.g. phone formatting) and rejects it if invalid. For username and chat_id contacts, channel_type is required.

lead_idLead Idrequired

ID of the lead this record relates to.

product_idProduct Idrequired

ID of the product (workspace) that owns this record. Most endpoints scope access by product.

contactContactrequired

The address value. Will be normalized server-side.

contact_typeContactTyperequired

The kind of address — phone, username, chat_id, or email.

Possible values: [phone, username, chat_id, email]

channel_type object

Messaging platform; required for username and chat_id contacts.

anyOf

• string
• null

string

Possible values: [telegram, whatsapp, waba, max, viber, instagram, fasttrack, usedesk, salebot, avito, vk, yandex_messenger, email, sms, pinbox, linkedin, amocrm_salesbot, bitrix24_openlines, sip, webrtc, bothelp]

ext_channel_id object

anyOf

• string
• null

string

channel_vendor object

anyOf

• string
• null

string

Possible values: [wazzup24, self_wz, chatpush, greenapi, wappi, chatapp, yandex_messenger, salebot, bothelp, radist, fasttrack, usedesk, amocrm_salesbot, bitrix24_openlines, twilio, mail.ru, gmail, pinbox, unipile, voice]

is_mainIs Main

Whether this becomes the lead's primary contact.

Default value: false

crm_id object

Identifier of the matching record in the connected external CRM, if any.

anyOf

• string
• null

string

contact_sourceContactSource

Possible values: [custom_field, default_field, derived_title, api, unknown]

Default value: unknown

source_name object

anyOf

• string
• null

string

last_dialogue_id object

anyOf

• integer
• null

integer

skip_routingSkip Routing

When true, exclude this contact from automatic outreach routing.

Default value: false

waba_window_open_until object

anyOf

• date-time
• null

date-time

waba_windows_openedWaba Windows Opened

Default value: 0

ContactCreate

{
  "lead_id": 0,
  "product_id": 0,
  "contact": "string",
  "contact_type": "phone",
  "channel_type": "telegram",
  "ext_channel_id": "string",
  "channel_vendor": "wazzup24",
  "is_main": false,
  "crm_id": "string",
  "contact_source": "unknown",
  "source_name": "string",
  "last_dialogue_id": 0,
  "skip_routing": false,
  "waba_window_open_until": "2024-07-29T15:51:28.071Z",
  "waba_windows_opened": 0
}