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: crm

Who 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
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

Province

ADDRESS_REGION
string

Region

ASSIGNED_BY_ID
user

Responsible person

BIRTHDATE
date

Birthdate

COMMENTS
string

Comments

COMPANY_ID
crm_company

Link the lead to a company

COMPANY_TITLE
string

Company name as 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 Open Channels. Multiple

LAST_NAME
string

Last name

NAME
string

First name

SECOND_NAME
string

Middle name

OPENED
char

Indicator of lead availability for 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 process

PROCESSED

Processed

JUNK

Low-quality lead

CONVERTED

High-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 Ads, Bing Ads, etc.

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 lead addition event. Additionally, a notification will be sent to the responsible person for the lead

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
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 consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

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
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

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

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

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 — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not 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

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

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 provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

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

Continue Learning