Перейти к основному содержимому

LeadWithContactsCreate

Тело запроса для создания лида вместе с его контактами одним атомарным вызовом.

lead objectrequired

Тело запроса для создания или замены лида. Неизвестные поля отклоняются.

product_idProduct Idrequired

Идентификатор продукта, которому будет принадлежать лид. Обязательное поле.

stage_idStage Idrequired

Идентификатор начального этапа воронки. Обязательное поле.

stage_set_at object

Необязательное переопределение момента перехода на этап; по умолчанию — текущее время.

anyOf
date-time
name object

Необязательное отображаемое имя.

anyOf
string
crm_id object

Идентификатор соответствующей записи в подключённой внешней CRM, если есть.

anyOf
string
crm_fields object

Необязательные начальные пары ключ/значение для CRM.

property name* object
anyOf
string
is_testIs Test

Создать лида как тестового (исключается из продуктовых метрик).

Default value: false
batch_name object

Необязательная метка партии.

anyOf
string
timezone object

Необязательный часовой пояс IANA для планирования.

anyOf
string
status object

Необязательная произвольная строка статуса.

anyOf
string
is_activeIs Active

Активен ли лид сразу. По умолчанию true.

Default value: true
from_crm_integration_id object

Если задано, лид помечается как импортированный из этой интеграции с CRM (должна существовать).

anyOf
integer
from_pipeline_id object

Необязательный идентификатор исходной воронки CRM.

anyOf
string
contacts object[]required

Контакты, которые нужно привязать к новому лиду.

  • Array [
    • contactContactrequired

    Значение контакта — номер телефона, username, chat_id или email в зависимости от contact_type.

    contact_typeContactTyperequired

    Вид адреса — phone, username, chat_id или email.

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

    channel_type object

    Мессенджер, к которому относится адрес. Обязателен для контактов типа username и chat_id.

    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

    Необязательная привязка к конкретному внешнему каналу (например, закрепить chat_id за одним ботом).

    anyOf
    string
    channel_vendor object

    Необязательный провайдер, к которому привязан адрес.

    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

    Является ли контакт основным для лида.

    Default value: false
    crm_id object

    Идентификатор соответствующей записи в подключённой внешней CRM, если есть.

    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

    Если true, контакт исключается из автоматической маршрутизации исходящих рассылок.

    Default value: false
  • ]
    • deduplicate_contactsDeduplicate Contacts

    Если true (по умолчанию), запрос отклоняется с кодом 409 при дубликатах контактов внутри запроса или при контактах, уже существующих в продукте.

    Default value: true
    LeadWithContactsCreate
    {
      "lead": {
        "product_id": 0,
        "stage_id": 0,
        "stage_set_at": "2024-07-29T15:51:28.071Z",
        "name": "string",
        "crm_id": "string",
        "crm_fields": {},
        "is_test": false,
        "batch_name": "string",
        "timezone": "string",
        "status": "string",
        "is_active": true,
        "from_crm_integration_id": 0,
        "from_pipeline_id": "string"
      },
      "contacts": [
        {
          "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
        }
      ],
      "deduplicate_contacts": true
    }