28.05.2026 00:00

Add

[POST] .../v1/lead/add

Создает CRM-обращение (Lead).

Входные параметры

Название Тип данных Обязательность Описание
client_id Int64 Необязательный ID клиента в CRM
ticket_id Int64 Необязательный ID тикета-источника (информационная ссылка)
chat_id String(36) Необязательный UUID существующего чата, который нужно привязать к лиду
pipeline_id Int64 Необязательный ID воронки; если не передан, используется воронка по умолчанию для Lead
stage_id Int64 Необязательный ID не терминальной стадии; если не передан, используется стартовая стадия воронки
responsible_user_id Int64 Необязательный ID ответственного пользователя
participant_user_ids Array of Int64 Необязательный Участники обращения
title String Необязательный Тема обращения
description String Необязательный Описание обращения
description_mentions Array of CommonMentionInput Необязательный Структурированные упоминания пользователей в description
mention_options CommonMentionOptions Необязательный Опции обработки упоминаний
amount Decimal Необязательный Сумма обращения
fields Array of FieldValueAdd Необязательный Значения дополнительных полей

stage_id не должен указывать на терминальную стадию (is_terminal = true). Для закрытия обращения используйте lead/setstage или lead/close; для успешной конвертации используйте lead/convert.

Если в description_mentions указан пользователь, которого нет среди participant_user_ids или ответственного, по умолчанию метод вернет ошибку mentioned_user_not_in_context. При mention_options.add_missing_users_to_context = true такие пользователи автоматически добавляются в участники обращения.

Пример запроса

{
  "client_id": 501,
  "ticket_id": 9001,
  "title": "Заявка с сайта",
  "description": "Клиент просит перезвонить после 15:00",
  "amount": 2500.00,
  "chat_id": "3e73d8f2-66be-4d5a-a35d-03f7dc61a4a9",
  "responsible_user_id": 15,
  "participant_user_ids": [18],
  "fields": []
}

Выходные параметры

Название Тип данных Описание
result.new_id Int64 ID созданного обращения

Пример ответа

{
  "ok": true,
  "result": {
    "new_id": 105
  }
}

Пример ошибки

{
  "ok": false,
  "result": {
    "error": 1044,
    "description": "ticket_id"
  }
}