# crm.lead.add

URL: https://chugunov.pro/api-bitrix24/crm/leads/crm-lead-add/
Проверено на Битрикс24 REST API, обновлено 11.09.2026 (ревизия источника fb39d6c).
Источник: официальная документация Битрикс24 (bitrix-tools/b24-rest-docs, лицензия MIT, © Bitrix). Справочник независимый, официальной документацией не является.

Создать новый лид
Scope: `crm`
Кто может выполнять метод: любой пользователь с правом на создание лидов

> Устаревший метод. Развитие метода остановлено. Используйте crm.item.add.

## Описание

Метод `crm.lead.add` создает новый лид.

## Параметры

- `fields` `object` — необязательный. Объект формата:
  ```
  {
      field_1: value_1,
      field_2: value_2,
      ...,
      field_n: value_n,
  }
  ```
  где:
  - `field_n` — название поля
  - `value_n` — значение поля
  Список доступных полей описан [ниже](#fields)
- `params` `object` — необязательный. Необязательный массив опций (`"optionName"=>"value"[, ...]`). Перечень возможных полей описан [ниже](#params)

### Параметр fields

- `ADDRESS` `string` — необязательный. Адрес
- `ADDRESS_2` `string` — необязательный. Вторая страница адреса. В некоторых странах принято разбивать адрес на 2 части
- `ADDRESS_CITY` `string` — необязательный. Город
- `ADDRESS_COUNTRY` `string` — необязательный. Страна
- `ADDRESS_COUNTRY_CODE` `string` — необязательный. Код страны
- `ADDRESS_POSTAL_CODE` `string` — необязательный. Почтовый индекс
- `ADDRESS_PROVINCE` `string` — необязательный. Область
- `ADDRESS_REGION` `string` — необязательный. Район
- `ASSIGNED_BY_ID` `user` — необязательный. Ответственный
- `BIRTHDATE` `date` — необязательный. Дата рождения
- `COMMENTS` `string` — необязательный. Комментарии
- `COMPANY_ID` `crm_company` — необязательный. Привязка лида к компании
- `COMPANY_TITLE` `string` — необязательный. Название компании, указанное в соответствующем поле лида. Для привязки существующей компании стоит передавать её id в поле COMPANY_ID
- `CONTACT_ID` `crm_contact` — необязательный. Привязка лида к контакту
- `CONTACT_IDS` `crm_contact` — необязательный. Список привязанных к лиду контактов.
  Контакты можно добавлять или удалять группой методов [crm.lead.contact.*](https://chugunov.pro/api-bitrix24/crm/leads/management-communication/)
- `CURRENCY_ID` `crm_currency` — необязательный. Идентификатор валюты
- `EMAIL` `crm_multifield` — необязательный. Адрес электронной почты. Множественное
- `HONORIFIC` `crm_status` — необязательный. Вид обращения
- `IM` `crm_multifield` — необязательный. Мессенджер. Множественное
- `LINK` `crm_multifield` — необязательный. ID пользователя, привязанного через открытую линию. Множественное
- `LAST_NAME` `string` — необязательный. Фамилия
- `NAME` `string` — необязательный. Имя
- `SECOND_NAME` `string` — необязательный. Отчество
- `OPENED` `char` — необязательный. Признак доступности лида для всех.  Допустимые значения `Y` или `N`.
- `OPPORTUNITY` `double` — необязательный. Сумма
- `IS_MANUAL_OPPORTUNITY` `char` — необязательный. Признак ручного режима расчёта суммы.  Допустимые значения Y или N
- `ORIGINATOR_ID` `string` — необязательный. Идентификатор источника данных.
  Используется только для привязки к внешнему источнику
- `ORIGIN_ID` `string` — необязательный. Идентификатор элемента в источнике данных. Используется только для привязки к внешнему источнику
- `PHONE` `crm_multifield` — необязательный. Телефон. Множественное
- `POST` `string` — необязательный. Должность
- `SOURCE_DESCRIPTION` `string` — необязательный. Описание источника
- `SOURCE_ID` `crm_status` — необязательный. Идентификатор источника. 
  Значения по умолчанию:
  #

### Параметр params

- `REGISTER_SONET_EVENT` `boolean` — необязательный. Флаг `Y`/`N` - произвести регистрацию события добавления лида. Дополнительно будет отправлено уведомление ответственному за лид

## Ответ

HTTP-статус: 200

```json
{
    "result": 3465,
    "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` `integer`. Корневой элемент ответа, содержит идентификатор созданного лида
- `time` `time`. Информация о времени выполнения запроса

## Ошибки

```json
{
    "error": "",
    "error_description": "Access denied."
}
```


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

### cURL (Webhook)

```bash
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"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.add
```

### cURL (OAuth)

```bash
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"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.add
```

### JS (TS)

```ts
// 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<number>({
    method: 'crm.lead.add',
    params: {
      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('Created lead id:', result)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
```

### JS (UMD)

```html
<!-- 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 addLead() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'crm.lead.add',
        params: {
          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('Created lead id:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', addLead)
</script>
```

### Python

```python
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
from datetime import datetime

lead_birthdate = datetime(1989, 7, 14).date().isoformat()

try:
    bitrix_response = client.crm.lead.add(
        fields={
        "TITLE": "Acme Industrial Subscription",
        "NAME": "Jordan",
        "SECOND_NAME": "Avery",
        "LAST_NAME": "Miller",
        "STATUS_ID": "NEW",
        "OPENED": "Y",
        "ASSIGNED_BY_ID": 1,
        "CURRENCY_ID": "USD",
        "OPPORTUNITY": 25000.0,
        "IS_MANUAL_OPPORTUNITY": "Y",
        "SOURCE_ID": "WEB",
        "SOURCE_DESCRIPTION": "Inbound product comparison form",
        "COMMENTS": "Requested enterprise onboarding call next week.",
        "COMPANY_TITLE": "Acme Industrial LLC",
        "POST": "Procurement Director",
        "BIRTHDATE": lead_birthdate,
        "PHONE": [{"VALUE": "+12025550119", "VALUE_TYPE": "WORK"}],
        "EMAIL": [{"VALUE": "jordan.miller@acme-industrial.com", "VALUE_TYPE": "WORK"}],
        "WEB": [{"VALUE": "https://acme-industrial.com", "VALUE_TYPE": "WORK"}],
        "UTM_SOURCE": "google-ads",
        "UTM_MEDIUM": "cpc",
        "UTM_CAMPAIGN": "q1_enterprise_leads",
        "UTM_CONTENT": "landing_form_variant_a",
        "UTM_TERM": "industrial crm integration",
        },
        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}")
```

### PHP

```php
try {
    $response = $b24Service
        ->core
        ->call(
            'crm.lead.add',
            [
                '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 = $response
        ->getResponseData()
        ->getResult();

    echo 'Создан лид с ID ' . $result;

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Ошибка при создании лида: ' . $e->getMessage();
}
```

### BX24.js

```js
BX24.callMethod(
    "crm.lead.add",
    {
        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(`Создан лид с ID ${result.data()}`);
    }
);
```

### PHP CRest

```php
require_once('crest.php');

$result = CRest::call(
    'crm.lead.add',
    [
        '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',
        ]
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
```

### Go

```go
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.lead.add", b24.Params{
	"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.add: %w", err)
}

var newID b24.ID
if err := json.Unmarshal(res.Result, &newID); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("идентификатор:", newID)
```

Оригинал в официальной документации: https://apidocs.bitrix24.ru/api-reference/crm/leads/crm-lead-add.html