Set Parameters for crm.lead.details.configuration.set

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 can set their own settings,

a user with the "Allow to change settings" access permission in CRM can set others' and shared settings.

DEPRECATED

The development of this method has been halted. Please use crm.item.details.configuration.set.

The method crm.lead.details.configuration.set sets the settings for lead cards.

Warning

The settings for repeat leads may differ from those for simple leads. To switch between lead card settings, use the leadCustomerType parameter.

Method Parameters

Required parameters are marked with *

Name `type`	Description
data* `section[]`	A list of sections in the card. Each section contains a set of fields that will be displayed in the lead card.
userId `user`	The identifier of the user for whom to save the personal configuration. If the parameter is not provided, the `userId` of the user calling the method will be used. This is only required when setting personal settings.
scope `string`	The scope of the settings. Possible values: `'P'` - personal settings `'C'` - shared settings The default value is `'P'`.
extras `object`	Additional parameters for selecting the lead type. The structure is described below

Parameter section

Name `type`	Description
name* `string`	Unique name of the section.
title* `string`	Title of the section.
type* `string`	Type of the section. Only the value `'section'` is supported.
elements `section_element[]`	A list of fields displayed in the section.

Parameter section_element

Name `type`	Description
name* `string`	Identifier of the lead field. A list of available fields can be obtained using the crm.lead.fields method.
optionFlags `integer`	Whether to always show the field: `1` - yes `0` - no The default value is `0`.
options `object`	Additional options for the field. The set of options depends on the field type.

Parameter extras

Name
type

Description

leadCustomerType
integer

Type of lead. Possible values:

1 - simple lead
2 - repeat lead

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"scope":"P","userId":1,"extras":{"leadCustomerType":2},"data":[{"name":"main","title":"About the Lead","type":"section","elements":[{"name":"TITLE"},{"name":"STATUS_ID"},{"name":"SOURCE_ID"},{"name":"NAME"},{"name":"PHONE","optionFlags":1}]},{"name":"additional","title":"Additional Information","type":"section","elements":[{"name":"ASSIGNED_BY_ID"},{"name":"COMMENTS"}]}]}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.lead.details.configuration.set

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"scope":"P","userId":1,"extras":{"leadCustomerType":2},"data":[{"name":"main","title":"About the Lead","type":"section","elements":[{"name":"TITLE"},{"name":"STATUS_ID"},{"name":"SOURCE_ID"},{"name":"NAME"},{"name":"PHONE","optionFlags":1}]},{"name":"additional","title":"Additional Information","type":"section","elements":[{"name":"ASSIGNED_BY_ID"},{"name":"COMMENTS"}]}],"auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/crm.lead.details.configuration.set

// 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.details.configuration.set',
            params: {
              scope: 'P',
              userId: 1,
              extras: {
                leadCustomerType: 2,
              },
              data: [
                {
                  name: 'main',
                  title: 'About lead',
                  type: 'section',
                  elements: [
                    { name: 'TITLE' },
                    { name: 'STATUS_ID' },
                    { name: 'SOURCE_ID' },
                    { name: 'NAME' },
                    { name: 'PHONE', optionFlags: 1 },
                  ],
                },
                {
                  name: 'additional',
                  title: 'Additional',
                  type: 'section',
                  elements: [
                    { name: 'ASSIGNED_BY_ID' },
                    { name: 'COMMENTS' },
                  ],
                },
              ],
            },
            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('Configuration saved:', 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 setLeadCardConfiguration() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'crm.lead.details.configuration.set',
                params: {
                  scope: 'P',
                  userId: 1,
                  extras: {
                    leadCustomerType: 2,
                  },
                  data: [
                    {
                      name: 'main',
                      title: 'About lead',
                      type: 'section',
                      elements: [
                        { name: 'TITLE' },
                        { name: 'STATUS_ID' },
                        { name: 'SOURCE_ID' },
                        { name: 'NAME' },
                        { name: 'PHONE', optionFlags: 1 },
                      ],
                    },
                    {
                      name: 'additional',
                      title: 'Additional',
                      type: 'section',
                      elements: [
                        { name: 'ASSIGNED_BY_ID' },
                        { name: 'COMMENTS' },
                      ],
                    },
                  ],
                },
                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('Configuration saved:', result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', setLeadCardConfiguration)
        </script>


        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.lead.details.configuration.set(
                scope="P",
                user_id=1,
                extras={"leadCustomerType": 2},
            ).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.details.configuration.set',
                    [
                        'scope' => 'P',
                        'userId' => 1,
                        'extras' => [
                            'leadCustomerType' => 2,
                        ],
                        'data' => [
                            [
                                'name' => 'main',
                                'title' => 'About the Lead',
                                'type' => 'section',
                                'elements' => [
                                    ['name' => 'TITLE'],
                                    ['name' => 'STATUS_ID'],
                                    ['name' => 'SOURCE_ID'],
                                    ['name' => 'NAME'],
                                    ['name' => 'PHONE', 'optionFlags' => 1],
                                ],
                            ],
                            [
                                'name' => 'additional',
                                'title' => 'Additional Information',
                                'type' => 'section',
                                'elements' => [
                                    ['name' => 'ASSIGNED_BY_ID'],
                                    ['name' => 'COMMENTS'],
                                ],
                            ],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Result: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }

BX24.callMethod(
            'crm.lead.details.configuration.set',
            {
                scope: 'P',
                userId: 1,
                extras: {
                    leadCustomerType: 2
                },
                data: [
                    {
                        name: 'main',
                        title: 'About the Lead',
                        type: 'section',
                        elements: [
                            { name: 'TITLE' },
                            { name: 'STATUS_ID' },
                            { name: 'SOURCE_ID' },
                            { name: 'NAME' },
                            { name: 'PHONE', optionFlags: 1 }
                        ]
                    },
                    {
                        name: 'additional',
                        title: 'Additional Information',
                        type: 'section',
                        elements: [
                            { name: 'ASSIGNED_BY_ID' },
                            { name: 'COMMENTS' }
                        ]
                    }
                ]
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.lead.details.configuration.set',
            [
                'scope' => 'P',
                'userId' => 1,
                'extras' => [
                    'leadCustomerType' => 2,
                ],
                'data' => [
                    [
                        'name' => 'main',
                        'title' => 'About the Lead',
                        'type' => 'section',
                        'elements' => [
                            ['name' => 'TITLE'],
                            ['name' => 'STATUS_ID'],
                            ['name' => 'SOURCE_ID'],
                            ['name' => 'NAME'],
                            ['name' => 'PHONE', 'optionFlags' => 1],
                        ],
                    ],
                    [
                        'name' => 'additional',
                        'title' => 'Additional Information',
                        'type' => 'section',
                        'elements' => [
                            ['name' => 'ASSIGNED_BY_ID'],
                            ['name' => 'COMMENTS'],
                        ],
                    ],
                ],
            ]
        );
        
        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.details.configuration.set", b24.Params{
        	"scope":  "P",
        	"userId": 1,
        	"extras": b24.Params{
        		"leadCustomerType": 2,
        	},
        	"data": []b24.Params{
        		{
        			"name":  "main",
        			"title": "About the Lead",
        			"type":  "section",
        			"elements": []b24.Params{
        				{
        					"name": "TITLE",
        				},
        				{
        					"name": "STATUS_ID",
        				},
        				{
        					"name": "SOURCE_ID",
        				},
        				{
        					"name": "NAME",
        				},
        				{
        					"name":        "PHONE",
        					"optionFlags": 1,
        				},
        			},
        		},
        		{
        			"name":  "additional",
        			"title": "Additional Information",
        			"type":  "section",
        			"elements": []b24.Params{
        				{
        					"name": "ASSIGNED_BY_ID",
        				},
        				{
        					"name": "COMMENTS",
        				},
        			},
        		},
        	},
        })
        if err != nil {
        	return fmt.Errorf("crm.lead.details.configuration.set: %w", err)
        }
        
        var ok bool
        if err := json.Unmarshal(res.Result, &ok); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println("done:", ok)

Response Handling

HTTP Status: 200

{
            "result": true,
            "time": {
                "start": 1720728468.828951,
                "finish": 1720728469.214046,
                "duration": 0.38509488105773926,
                "processing": 0.018099069595336914,
                "date_start": "2024-07-11T22:54:28+02:00",
                "date_finish": "2024-07-11T22:54:29+02:00",
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `boolean`	The root element of the response. Returns `true` if the settings were successfully saved.
time `time`	Information about the execution time of the request.

Error Handling

HTTP Status: 400

{
            "error": "",
            "error_description": "Element at index 0 in section at index 1 does not have name."
        }

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

Code	Description	Value
Empty value	Access denied	Insufficient permissions.
Empty value	Parameter 'data' must be array	The `data` parameter is not an array.
Empty value	The data must be indexed array	The `data` parameter is not an indexed array.
Empty value	There are no data to write	An empty array was passed in `data`.
Empty value	Section at index `i` has type `data[i].type`. The expected type is 'section'	A value other than `'section'` was passed in `data[i].type`.
Empty value	Section at index `i` does not have name	An empty value was passed in `data[i].name`.
Empty value	Section at index `i` does not have title	An empty value was passed in `data[i].title`.
Empty value	Element at index `j` in section at index `i` does not have name	An empty value was passed in `data[i].elements[j].name`.

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

Was the article helpful?

Reset Card Parameters

Set Common Card for All Users

Set Parameters for crm.lead.details.configuration.set

Method ParametersMethod Parameters

Parameter sectionParameter section

Parameter section_elementParameter section_element

Parameter extrasParameter extras

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning