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

Scope: crm

Who can execute the method:

any user can set their own settings,

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

Method Development Halted

The method crm.lead.details.configuration.set continues to function, but there is a more relevant alternative: 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. Required only 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)

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

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

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

Code	Description	Value
`-`	Access denied	Insufficient permissions.
`-`	Parameter `data` must be array	`data` is not an array.
`-`	The data must be indexed array	`data` is not an indexed array.
`-`	There are no data to write	`data` is an empty array.
`-`	Section at index `i` have type `data[i].type`. The expected type is 'section'	`data[i].type` is not equal to `'section'`.
`-`	Section at index `i` does not have name	`data[i].name` is empty.
`-`	Section at index `i` does not have title	`data[i].title` is empty.
`-`	Element at index `j` in section at index `i` does not have name	`data[i].elements[j].name` is empty.

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

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