Skip to main content

ContactCreateRaw

A contact to attach to a lead, without lead/product context (those are taken from the enclosing request).

contactContactrequired

The contact value — a phone number, username, chat id, or email depending on contact_type.

contact_typeContactTyperequired

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

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

channel_type object

Messaging platform the address belongs to. Required for username and chat_id contacts.

anyOf
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

Optional binding to a specific external channel (e.g. pin a chat_id to one bot).

anyOf
string
channel_vendor object

Optional messaging-provider vendor the address is pinned to.

anyOf
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 is 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
contact_sourceContactSource

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

Default value: unknown
source_name object
anyOf
string
skip_routingSkip Routing

When true, the contact is excluded from automatic outreach routing.

Default value: false
ContactCreateRaw
{
  "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",
  "skip_routing": false
}