Create a New Lead crm.lead.add

Scope: crm

Who can execute the method: any user with permission to create leads

Method Development Stopped

The method crm.lead.add continues to function, but there is a more relevant alternative crm.item.add.

The method crm.lead.add creates a new lead.

Method Parameters

Required parameters are marked with *

Name
type

Description

fields
object

Object format:

{
            field_1: value_1,
            field_2: value_2,
            ...,
            field_n: value_n,
        }

where:

field_n — field name
value_n — field value

The list of available fields is described below

params
object

Optional array of options ("optionName"=>"value"[, ...]). The list of possible fields is described below

Parameter fields

Name
type

Description

ADDRESS
string

Address

ADDRESS_2
string

Second line of the address. In some countries, it is customary to split the address into 2 parts

ADDRESS_CITY
string

City

ADDRESS_COUNTRY
string

Country

ADDRESS_COUNTRY_CODE
string

Country code

ADDRESS_POSTAL_CODE
string

Postal code

ADDRESS_PROVINCE
string

State

ADDRESS_REGION
string

Region

ASSIGNED_BY_ID
user

Responsible person

BIRTHDATE
date

Date of birth

COMMENTS
string

Comments

COMPANY_ID
crm_company

Link the lead to a company

COMPANY_TITLE
string

Company name specified in the corresponding lead field. To link an existing company, pass its id in the COMPANY_ID field

CONTACT_ID
crm_contact

Link the lead to a contact

CONTACT_IDS
crm_contact

List of contacts linked to the lead.

Contacts can be added or removed using the group of methods crm.lead.contact.*

CURRENCY_ID
crm_currency

Currency identifier

EMAIL
crm_multifield

Email address. Multiple

HONORIFIC
crm_status

Salutation

IM
crm_multifield

Messenger. Multiple

LINK
crm_multifield

User ID linked through an open channel. Multiple

LAST_NAME
string

Last name

NAME
string

First name

SECOND_NAME
string

Middle name

OPENED
char

Indicator of lead availability to everyone. Acceptable values are Y or N.

OPPORTUNITY
double

Amount

IS_MANUAL_OPPORTUNITY
char

Indicator of manual calculation mode for the amount. Acceptable values are Y or N

ORIGINATOR_ID
string

Identifier of the data source.

Used only for linking to an external source

ORIGIN_ID
string

Identifier of the item in the data source. Used only for linking to an external source

PHONE
crm_multifield

Phone. Multiple

POST
string

Position

SOURCE_DESCRIPTION
string

Description of the source

SOURCE_ID
crm_status

Identifier of the source.
Default values:

SOURCE_ID	Name
CALL	Call
EMAIL	E-mail
WEB	Website
ADVERTISING	Advertising
PARTNER	Existing client
RECOMMENDATION	By recommendation
TRADE_SHOW	Trade show
WEBFORM	CRM form
CALLBACK	Callback
RC_GENERATOR	Sales generator
STORE	Online store
OTHER	Other

The list of all possible identifiers from the directory can be obtained using the method crm.status.list with the filter filter[ENTITY_ID]=SOURCE

STATUS_DESCRIPTION
string

Additional information about the stage

STATUS_ID
crm_status

Identifier of the lead stage. Default stages:

STATUS_ID	Name
NEW	Unprocessed
IN_PROCESS	In progress
PROCESSED	Processed
JUNK	Low-quality lead
CONVERTED	Quality lead

The list of all possible stages from the directory can be obtained using the method crm.status.list with the filter filter[ENTITY_ID]=STATUS

TITLE
string

Lead title

UTM_CAMPAIGN
string

Advertising campaign designation

UTM_CONTENT
string

Content of the campaign. For example, for contextual ads

UTM_MEDIUM
string

Type of traffic. CPC (ads), CPM (banners)

UTM_SOURCE
string

Advertising system. Google AdWords, and others

UTM_TERM
string

Search condition of the campaign. For example, keywords for contextual advertising

WEB
crm_multifield

Website. Multiple

UF_...

Custom fields. For example, UF_CRM_25534736.

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 `type`	Description
REGISTER_SONET_EVENT `boolean`	Flag `Y`/`N` - register the event of adding a lead. Additionally, a notification will be sent to the person responsible for the lead

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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

try
        {
        	const response = await $b24.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',
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(`Lead created with ID ${result}`);
        }
        catch( error )
        {
        	console.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>';

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 `type`	Description
result `integer`	Root element of the response, contains the identifier of the created lead
time `time`	Information about the execution time of the request

Error Handling

HTTP status: 40x, 50x Error

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

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

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: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Overview of Methods

Update Lead

Create a New Lead crm.lead.add

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Parameter paramsParameter params

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible ErrorsPossible Errors

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning