Reset CRM Lead Details Configuration Parameters

Scope: crm

Who can execute the method:

any user can reset their own settings,

a user with the "Allow to modify settings" access permission in CRM can reset both general and others' settings.

Method Development Stopped

The method crm.lead.details.configuration.reset continues to function, but there is a more relevant alternative: crm.item.details.configuration.reset.

The method crm.lead.details.configuration.reset resets the settings of lead cards.

Warning

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

Method Parameters

Required parameters are marked with *

Name `type`	Description
userId `user`	The identifier of the user for whom the personal configuration needs to be reset. If the parameter is not provided, the `userId` of the user calling the method will be used. This is only required when resetting personal settings.
scope `string`	The scope of the settings. Possible values: `'P'` - personal settings `'C'` - general settings The default value is `'P'`.
extras `object`	Additional parameters for selecting the type of lead. The structure is described below

Extras Parameter

Name
type

Description

lead.customer.type
integer

Type of lead. Possible values:

1 - simple lead
2 - repeat lead

Code Examples

How to Use Examples in Documentation

Reset Personal Card Settings

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}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.lead.details.configuration.reset

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"scope":"P","userId":1,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.lead.details.configuration.reset

try
        {
            const response = await $b24.callMethod(
                'crm.lead.details.configuration.reset',
                {
                    scope: 'P',
                    userId: 1
                }
            );
            
            const result = response.getData().result;
            console.dir(result);
        }
        catch(error)
        {
            console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.lead.details.configuration.reset',
                    [
                        'scope'  => 'P',
                        'userId' => 1,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error resetting lead details configuration: ' . $e->getMessage();
        }

BX24.callMethod(
            "crm.lead.details.configuration.reset",
            {
                scope: "P",
                userId: 1
            },
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.lead.details.configuration.reset',
            [
                'scope' => 'P',
                'userId' => 1
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Reset General Card Settings

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"scope":"C"}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.lead.details.configuration.reset

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"scope":"C","auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.lead.details.configuration.reset

try
        {
        	const response = await $b24.callMethod(
        		"crm.lead.details.configuration.reset",
        		{
        			scope: "C"
        		}
        	);
        	
        	const result = response.getData().result;
        	console.dir(result);
        }
        catch(error)
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.lead.details.configuration.reset',
                    [
                        'scope'  => 'C',
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error resetting lead details configuration: ' . $e->getMessage();
        }

BX24.callMethod(
            "crm.lead.details.configuration.reset",
            {
                scope: "C"
            },
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.lead.details.configuration.reset',
            [
                'scope' => 'C'
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

{
            "result": true,
            "time": {
                "start": 1720687072.190654,
                "finish": 1720687072.586945,
                "duration": 0.39629101753234863,
                "processing": 0.057084083557128906,
                "date_start": "2024-07-11T10:37:52+02:00",
                "date_finish": "2024-07-11T10:37:52+02:00",
                "operating": 0
            }
        }

Returned Data

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

Error Handling

HTTP Status: 400

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

Code	Description	Value
`-`	Access denied	Insufficient permissions to reset the requested configuration.

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

Get Card Parameters

Set Individual Card Parameters

Reset CRM Lead Details Configuration Parameters

Method ParametersMethod Parameters

Extras ParameterExtras Parameter

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