Изменить лид crm.lead.update
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
crmКто может выполнять метод: пользователь, имеющий права на редактирование лидов CRM
DEPRECATED
Развитие метода остановлено. Используйте метод REST 3.0 crm.lead.update.
Метод crm.lead.update обновляет существующий лид.
Параметры метода
Важно
Настоятельно рекомендуется при обновлении адреса передавать полный набор полей адреса в метод обновления. Особенности обновления полей адреса описаны здесь.
Обязательные параметры отмечены *
|
Название |
Описание |
|
id* |
Идентификатор лида. Идентификатор можно получить с помощью методов crm.lead.list или crm.lead.add |
|
fields |
Объект формата:
где:
Список доступных полей описан ниже. Некорректное поле в В |
|
params |
Необязательный набор опций. ( |
Параметр fields
|
Название |
Описание |
||||||||||||||||||||||||||
|
ADDRESS |
Адрес лида |
||||||||||||||||||||||||||
|
ADDRESS_2 |
Вторая страница адреса. В некоторых странах принято разбивать адрес на 2 части |
||||||||||||||||||||||||||
|
ADDRESS_CITY |
Город |
||||||||||||||||||||||||||
|
ADDRESS_COUNTRY |
Страна |
||||||||||||||||||||||||||
|
ADDRESS_COUNTRY_CODE |
Код страны |
||||||||||||||||||||||||||
|
ADDRESS_POSTAL_CODE |
Почтовый индекс |
||||||||||||||||||||||||||
|
ADDRESS_PROVINCE |
Область |
||||||||||||||||||||||||||
|
ADDRESS_REGION |
Район |
||||||||||||||||||||||||||
|
ASSIGNED_BY_ID |
Ответственный |
||||||||||||||||||||||||||
|
BIRTHDATE |
Дата рождения |
||||||||||||||||||||||||||
|
COMMENTS |
Комментарии |
||||||||||||||||||||||||||
|
COMPANY_ID |
Привязка лида к компании |
||||||||||||||||||||||||||
|
COMPANY_TITLE |
Название компании, указанное в соответствующем поле лида. Для привязки существующей компании стоит передавать её id в поле COMPANY_ID |
||||||||||||||||||||||||||
|
CONTACT_ID |
Привязка лида к контакту |
||||||||||||||||||||||||||
|
CONTACT_IDS |
Список привязанных к лиду контактов. Контакты можно добавлять или удалять группой методов crm.lead.contact.* |
||||||||||||||||||||||||||
|
CURRENCY_ID |
Идентификатор валюты |
||||||||||||||||||||||||||
|
EMAIL |
Адрес электронной почты. Множественное |
||||||||||||||||||||||||||
|
HONORIFIC |
Вид обращения |
||||||||||||||||||||||||||
|
Мессенджер. Множественное |
|||||||||||||||||||||||||||
|
LINK |
ID пользователя, привязанного через открытую линию. Множественное |
||||||||||||||||||||||||||
|
LAST_NAME |
Фамилия |
||||||||||||||||||||||||||
|
NAME |
Имя |
||||||||||||||||||||||||||
|
SECOND_NAME |
Отчество |
||||||||||||||||||||||||||
|
OPENED |
Признак доступности лида для всех. Допустимые значения Y или N |
||||||||||||||||||||||||||
|
OPPORTUNITY |
Сумма |
||||||||||||||||||||||||||
|
IS_MANUAL_OPPORTUNITY |
Признак ручного режима расчёта суммы. Допустимые значения Y или N |
||||||||||||||||||||||||||
|
ORIGINATOR_ID |
Идентификатор источника данных. Используется только для привязки к внешнему источнику |
||||||||||||||||||||||||||
|
ORIGIN_ID |
Идентификатор элемента в источнике данных. Используется только для привязки к внешнему источнику |
||||||||||||||||||||||||||
|
PHONE |
Телефон. Множественное |
||||||||||||||||||||||||||
|
POST |
Должность |
||||||||||||||||||||||||||
|
SOURCE_DESCRIPTION |
Описание источника |
||||||||||||||||||||||||||
|
SOURCE_ID |
Идентификатор источника.
Список всех возможных идентификаторов из справочника можно получить методом crm.status.list с фильтром |
||||||||||||||||||||||||||
|
STATUS_DESCRIPTION |
Дополнительно о стадии |
||||||||||||||||||||||||||
|
STATUS_ID |
Идентификатор стадии лида. Стадии по умолчанию:
Список всех возможных стадий из справочника можно получить методом crm.status.list с фильтром |
||||||||||||||||||||||||||
|
TITLE |
Название лида |
||||||||||||||||||||||||||
|
UTM_CAMPAIGN |
Обозначение рекламной кампании |
||||||||||||||||||||||||||
|
UTM_CONTENT |
Содержание кампании. Например, для контекстных объявлений |
||||||||||||||||||||||||||
|
UTM_MEDIUM |
Тип трафика. CPC (объявления), CPM (баннеры) |
||||||||||||||||||||||||||
|
UTM_SOURCE |
Рекламная система. Yandex-Direct, Google-Adwords и другие |
||||||||||||||||||||||||||
|
UTM_TERM |
Условие поиска кампании. Например, ключевые слова контекстной рекламы |
||||||||||||||||||||||||||
|
WEB |
Сайт. Множественное |
||||||||||||||||||||||||||
|
UF_... |
Пользовательские поля. Например, В зависимости от настроек портала у лидов может быть набор пользовательских полей определенных типов. Для изменения файловых полей рекомендуется использовать метод crm.item.update. Для создания, изменения или удаления пользовательских полей в лидах используйте методы crm.lead.userfield.* |
Примечание
Так же, чтобы узнать требуемый формат полей, можно выполнить метод crm.lead.fields и посмотреть формат пришедших значений этих полей.
Примечание
При изменении лида нельзя явно установить признак повторного лида (поле IS_RETURN_CUSTOMER), однако, это поле автоматически принимает значение Y, если при изменении лида указать значение для COMPANY_ID или CONTACT_ID
Параметр params
|
Название |
Описание |
|
REGISTER_SONET_EVENT |
произвести регистрацию события добавления лида в живой ленте. Дополнительно будет отправлено уведомление ответственному за лид. Допустимые значения |
Обязательные параметры отмечены *
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":1608,"fields":{"TITLE":"ИП Титов","NAME":"Глеб","SECOND_NAME":"Егорович","LAST_NAME":"Титов","STATUS_ID":"NEW","OPENED":"Y","ASSIGNED_BY_ID":1,"CURRENCY_ID":"USD","OPPORTUNITY":12500,"PHONE":[{"VALUE":"555888","VALUE_TYPE":"WORK"}],"WEB":[{"VALUE":"www.mysite.com","VALUE_TYPE":"WORK"}]},"params":{"REGISTER_SONET_EVENT":"Y"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.lead.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":1608,"fields":{"TITLE":"ИП Титов","NAME":"Глеб","SECOND_NAME":"Егорович","LAST_NAME":"Титов","STATUS_ID":"NEW","OPENED":"Y","ASSIGNED_BY_ID":1,"CURRENCY_ID":"USD","OPPORTUNITY":12500,"PHONE":[{"VALUE":"555888","VALUE_TYPE":"WORK"}],"WEB":[{"VALUE":"www.mysite.com","VALUE_TYPE":"WORK"}]},"params":{"REGISTER_SONET_EVENT":"Y"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.lead.update
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
try {
const response = await $b24.actions.v2.call.make<boolean>({
method: 'crm.lead.update',
params: {
id: 1608,
fields: {
TITLE: 'Sole proprietor Titov',
NAME: 'Gleb',
SECOND_NAME: 'Egorovich',
LAST_NAME: 'Titov',
STATUS_ID: 'NEW',
OPENED: 'Y',
ASSIGNED_BY_ID: 1,
CURRENCY_ID: 'USD',
OPPORTUNITY: 12500,
PHONE: [
{
VALUE: '555888',
VALUE_TYPE: 'WORK',
},
],
WEB: [
{
VALUE: 'www.mysite.com',
VALUE_TYPE: 'WORK',
},
],
},
params: {
REGISTER_SONET_EVENT: 'Y',
},
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Lead updated:', result)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function updateLead() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.lead.update',
params: {
id: 1608,
fields: {
TITLE: 'Sole proprietor Titov',
NAME: 'Gleb',
SECOND_NAME: 'Egorovich',
LAST_NAME: 'Titov',
STATUS_ID: 'NEW',
OPENED: 'Y',
ASSIGNED_BY_ID: 1,
CURRENCY_ID: 'USD',
OPPORTUNITY: 12500,
PHONE: [
{
VALUE: '555888',
VALUE_TYPE: 'WORK',
},
],
WEB: [
{
VALUE: 'www.mysite.com',
VALUE_TYPE: 'WORK',
},
],
},
params: {
REGISTER_SONET_EVENT: 'Y',
},
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Lead updated:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', updateLead)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
from datetime import datetime
updated_birthdate = datetime(1989, 7, 14).date().isoformat()
try:
bitrix_response = client.crm.lead.update(
bitrix_id=1201,
fields={
"TITLE": "Acme Industrial Subscription - Negotiation",
"STATUS_ID": "IN_PROCESS",
"OPPORTUNITY": 27500.0,
"CURRENCY_ID": "USD",
"ASSIGNED_BY_ID": 1,
"COMMENTS": "Budget approved, waiting for legal review.",
"SOURCE_DESCRIPTION": "Updated after discovery workshop",
"BIRTHDATE": updated_birthdate,
"PHONE": [{"VALUE": "+12025550120", "VALUE_TYPE": "WORK"}],
"EMAIL": [{"VALUE": "procurement@acme-industrial.com", "VALUE_TYPE": "WORK"}],
"WEB": [{"VALUE": "https://acme-industrial.com/contact", "VALUE_TYPE": "WORK"}],
"UTM_SOURCE": "linkedin",
"UTM_MEDIUM": "paid-social",
"UTM_CAMPAIGN": "enterprise_followup",
"UTM_CONTENT": "case_study_ad",
"UTM_TERM": "crm rollout",
},
params={"REGISTER_SONET_EVENT": "Y"},
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
try {
$id = 123; // Example lead ID
$fields = [
'TITLE' => 'Updated Lead Title',
'NAME' => 'John',
'LAST_NAME' => 'Doe',
'BIRTHDATE' => (new DateTime('1980-01-01'))->format(DateTime::ATOM),
'COMPANY_TITLE' => 'Example Company',
'STATUS_ID' => 'NEW',
'COMMENTS' => 'Updated comments for the lead.',
'PHONE' => '1234567890',
'EMAIL' => 'john.doe@example.com',
];
$params = [
'REGISTER_SONET_EVENT' => 'Y',
];
$result = $serviceBuilder->getCRMScope()->lead()->update($id, $fields, $params);
if ($result->isSuccess()) {
print($result->getCoreResponse()->getResponseData()->getResult()[0]);
} else {
print("Update failed.");
}
} catch (Throwable $e) {
print("Error: " . $e->getMessage());
}
BX24.callMethod(
"crm.lead.update",
{
id: 1608,
fields:
{
TITLE: "ИП Титов",
NAME: "Глеб",
SECOND_NAME: "Егорович",
LAST_NAME: "Титов",
STATUS_ID: "NEW",
OPENED: "Y",
ASSIGNED_BY_ID: 1,
CURRENCY_ID: "USD",
OPPORTUNITY: 12500,
PHONE: [
{
VALUE: "555888",
VALUE_TYPE: "WORK",
},
],
WEB: [
{
VALUE: "www.mysite.com",
VALUE_TYPE: "WORK",
}
],
},
params: {
REGISTER_SONET_EVENT: "Y",
}
},
(result) => {
if (result.error())
{
console.error(result.error());return;
}
console.info(result.data());
}
);
$fields = [
'TITLE' => $sTitle,
'COMPANY_ID' => 123,
'PHONE' => [
[
'VALUE' => '555888',
'VALUE_TYPE' => 'WORK',
],
],
];
$result = CRest::call(
'crm.lead.update',
[
'id' => 1608,
'fields' => $fields,
],
[
'REGISTER_SONET_EVENT' => 'Y',
]
);
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.lead.update", b24.Params{
"id": 1608,
"fields": b24.Params{
"TITLE": "ИП Титов",
"NAME": "Глеб",
"SECOND_NAME": "Егорович",
"LAST_NAME": "Титов",
"STATUS_ID": "NEW",
"OPENED": "Y",
"ASSIGNED_BY_ID": 1,
"CURRENCY_ID": "USD",
"OPPORTUNITY": 12500,
"PHONE": []b24.Params{
{
"VALUE": "555888",
"VALUE_TYPE": "WORK",
},
},
"WEB": []b24.Params{
{
"VALUE": "www.mysite.com",
"VALUE_TYPE": "WORK",
},
},
},
"params": b24.Params{
"REGISTER_SONET_EVENT": "Y",
},
})
if err != nil {
return fmt.Errorf("crm.lead.update: %w", err)
}
var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("выполнено:", ok)
Обработка ответа
HTTP-статус: 200
{
"result": true,
"time": {
"start": 1705764932.998683,
"finish": 1705764937.173995,
"duration": 4.1753120422363281,
"processing": 3.3076529502868652,
"date_start": "2024-01-20T18:35:32+03:00",
"date_finish": "2024-01-20T18:35:37+03:00",
"operating_reset_at": 1705765533,
"operating": 3.3076241016387939
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа, содержит |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 40x, 50x Error
{
"error": "",
"error_description": "ID is not defined or invalid."
}
Возможные ошибки
|
Текст ошибки |
Описание |
|
|
В параметр |
|
|
Лид с переданным |
|
|
У пользователя нет прав на редактирвоание лида |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |