Create a New Lead crm.lead.add
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
crmWho can execute the method: any user with permission to create leads
DEPRECATED
The development of this method has been halted. Please use crm.item.add.
The method crm.lead.add creates a new lead.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
fields |
Object format:
where:
The list of available fields is described below |
|
params |
Optional array of options ( |
Parameter fields
|
Name |
Description |
||||||||||||||||||||||||||
|
ADDRESS |
Address |
||||||||||||||||||||||||||
|
ADDRESS_2 |
Second line of the address. In some countries, it is customary to split the address into 2 parts |
||||||||||||||||||||||||||
|
ADDRESS_CITY |
City |
||||||||||||||||||||||||||
|
ADDRESS_COUNTRY |
Country |
||||||||||||||||||||||||||
|
ADDRESS_COUNTRY_CODE |
Country code |
||||||||||||||||||||||||||
|
ADDRESS_POSTAL_CODE |
Postal code |
||||||||||||||||||||||||||
|
ADDRESS_PROVINCE |
Province |
||||||||||||||||||||||||||
|
ADDRESS_REGION |
Region |
||||||||||||||||||||||||||
|
ASSIGNED_BY_ID |
Responsible person |
||||||||||||||||||||||||||
|
BIRTHDATE |
Birthdate |
||||||||||||||||||||||||||
|
COMMENTS |
Comments |
||||||||||||||||||||||||||
|
COMPANY_ID |
Link the lead to a company |
||||||||||||||||||||||||||
|
COMPANY_TITLE |
Company name as specified in the corresponding lead field. To link an existing company, pass its id in the COMPANY_ID field |
||||||||||||||||||||||||||
|
CONTACT_ID |
Link the lead to a contact |
||||||||||||||||||||||||||
|
CONTACT_IDS |
List of contacts linked to the lead. Contacts can be added or removed using the group of methods crm.lead.contact.* |
||||||||||||||||||||||||||
|
CURRENCY_ID |
Currency identifier |
||||||||||||||||||||||||||
|
EMAIL |
Email address. Multiple |
||||||||||||||||||||||||||
|
HONORIFIC |
Salutation |
||||||||||||||||||||||||||
|
Messenger. Multiple |
|||||||||||||||||||||||||||
|
LINK |
User ID linked through Open Channels. Multiple |
||||||||||||||||||||||||||
|
LAST_NAME |
Last name |
||||||||||||||||||||||||||
|
NAME |
First name |
||||||||||||||||||||||||||
|
SECOND_NAME |
Middle name |
||||||||||||||||||||||||||
|
OPENED |
Indicator of lead availability for everyone. Acceptable values are |
||||||||||||||||||||||||||
|
OPPORTUNITY |
Amount |
||||||||||||||||||||||||||
|
IS_MANUAL_OPPORTUNITY |
Indicator of manual calculation mode for the amount. Acceptable values are Y or N |
||||||||||||||||||||||||||
|
ORIGINATOR_ID |
Identifier of the data source. Used only for linking to an external source |
||||||||||||||||||||||||||
|
ORIGIN_ID |
Identifier of the item in the data source. Used only for linking to an external source |
||||||||||||||||||||||||||
|
PHONE |
Phone. Multiple |
||||||||||||||||||||||||||
|
POST |
Position |
||||||||||||||||||||||||||
|
SOURCE_DESCRIPTION |
Description of the source |
||||||||||||||||||||||||||
|
SOURCE_ID |
Identifier of the source.
The list of all possible identifiers from the directory can be obtained using the method crm.status.list with the filter |
||||||||||||||||||||||||||
|
STATUS_DESCRIPTION |
Additional information about the stage |
||||||||||||||||||||||||||
|
STATUS_ID |
Identifier of the lead stage. Default stages:
The list of all possible stages from the directory can be obtained using the method crm.status.list with the filter |
||||||||||||||||||||||||||
|
TITLE |
Lead title |
||||||||||||||||||||||||||
|
UTM_CAMPAIGN |
Advertising campaign designation |
||||||||||||||||||||||||||
|
UTM_CONTENT |
Content of the campaign. For example, for contextual ads |
||||||||||||||||||||||||||
|
UTM_MEDIUM |
Type of traffic. CPC (ads), CPM (banners) |
||||||||||||||||||||||||||
|
UTM_SOURCE |
Advertising system. Google Ads, Bing Ads, etc. |
||||||||||||||||||||||||||
|
UTM_TERM |
Search condition of the campaign. For example, keywords for contextual advertising |
||||||||||||||||||||||||||
|
WEB |
Website. Multiple |
||||||||||||||||||||||||||
|
UF_... |
Custom fields. For example, Depending on the portal settings, leads may have a set of custom fields of defined types. To create, modify, or delete custom fields in leads, use the methods crm.lead.userfield.* |
Note
Additionally, to find out the required format of fields, you can execute the method crm.lead.fields and check the format of the incoming values of these fields.
Note
When adding a lead, you cannot explicitly set the indicator for a repeat lead (the IS_RETURN_CUSTOMER field), however, this field automatically takes the value Y if you specify a value for COMPANY_ID or CONTACT_ID when adding the lead.
Parameter params
|
Name |
Description |
|
REGISTER_SONET_EVENT |
Flag |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"TITLE":"IP 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"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.lead.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"TITLE":"IP 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"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.lead.add
// 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)
}
<!-- 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>
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 error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
try {
$response = $b24Service
->core
->call(
'crm.lead.add',
[
'fields' => [
'TITLE' => 'IP 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',
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Lead created with ID ' . $result;
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error creating lead: ' . $e->getMessage();
}
BX24.callMethod(
"crm.lead.add",
{
fields:
{
TITLE: "IP 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",
}
},
(result) => {
if (result.error())
{
console.error(result.error());
return;
}
console.info(`Lead created with ID ${result.data()}`);
}
);
require_once('crest.php');
$result = CRest::call(
'crm.lead.add',
[
'fields' => [
'TITLE' => 'IP 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',
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "crm.lead.add", b24.Params{
"fields": b24.Params{
"TITLE": "IP Titov",
"NAME": "Gleb",
"SECOND_NAME": "Egorovich",
"LAST_NAME": "Titov",
"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("parse response: %w", err)
}
fmt.Println("id:", newID)
Response Handling
HTTP Status: 200
{
"result": 3465,
"time": {
"start": 1705764932.998683,
"finish": 1705764937.173995,
"duration": 4.1753120422363281,
"processing": 3.3076529502868652,
"date_start": "2024-01-20T18:35:32+01:00",
"date_finish": "2024-01-20T18:35:37+01:00",
"operating_reset_at": 1705765533,
"operating": 3.3076241016387939
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response, contains the identifier of the created lead |
|
time |
Information about the execution time of the request |
Error Handling
HTTP Status: 40x, 50x Error
{
"error": "",
"error_description": "Access denied."
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Errors
|
Code |
Error Text |
Description |
|
Empty Value |
Access denied. |
The user does not have permission to add a lead |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |