Reset Company Card Settings: crm.company.details.configuration.reset

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

Scope: crm

Who can execute this method:

  • any user can reset their own settings,
  • a user with the "Allow changing settings" access permission in CRM can reset both general and other users' settings.

DEPRECATED

Development of this method has been halted. Please use crm.item.details.configuration.reset.

The method crm.company.details.configuration.reset resets the settings of company cards: it removes the personal settings of the specified user or the general settings defined for all users.

Method Parameters

Required parameters are marked with *

Name
type

Description

scope
string

The scope of the settings.

Possible values:

  • P — personal settings
  • C — general settings

Default is P

userId
user

The user identifier, which can be obtained using the user.get method. Required only when resetting personal settings.

If not specified, the id of the current user is used.

Code Examples

How to Use Examples in Documentation

  1. Reset Personal Card Settings

    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.company.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.company.details.configuration.reset
            
    try
            {
            	const response = await $b24.callMethod(
            		"crm.company.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.company.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 company details configuration: ' . $e->getMessage();
            }
            
    BX24.callMethod(
                "crm.company.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.company.details.configuration.reset',
                [
                    'scope' => 'P',
                    'userId' => 1
                ]
            );
            
            echo '<PRE>';
            print_r($result);
            echo '</PRE>';
            
  2. Reset General Card Settings

    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.company.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.company.details.configuration.reset
            
    try
            {
            	const response = await $b24.callMethod(
            		"crm.company.details.configuration.reset",
            		{
            			scope: "C"
            		}
            	);
            	
            	const result = response.getData().result;
            	console.dir(result);
            }
            catch(error)
            {
            	console.error(error);
            }
            
    try {
                $response = $b24Service
                    ->core
                    ->call(
                        'crm.company.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 company details configuration: ' . $e->getMessage();
            }
            
    BX24.callMethod(
                "crm.company.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.company.details.configuration.reset',
                [
                    'scope' => 'C'
                ]
            );
            
            echo '<PRE>';
            print_r($result);
            echo '</PRE>';
            

Response Handling

HTTP Status: 200

{
            "result": true,
            "time": {
                "start": 1769420530,
                "finish": 1769420530.756109,
                "duration": 0.7561089992523193,
                "processing": 0,
                "date_start": "2026-01-26T12:42:10+01:00",
                "date_finish": "2026-01-26T12:42:10+01:00",
                "operating_reset_at": 1769421130,
                "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 request execution time

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

The user does not have permission to reset settings

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 permitted for calls 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 HTTPS protocol is required for method calls

503

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it

403

ACCESS_DENIED
REST API is available only on commercial plans

The REST API is only available on commercial plans

403

INVALID_CREDENTIALS
Invalid request credentials

The user associated with the access token or webhook used to call the method lacks the necessary 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 portal administrator has restricted access to this application to specific users only

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