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

Scope: crm

Who can execute the method:

any user can set their own settings,

a user with the "Allow changing settings" access permission in CRM can set others' and common settings

Method development has been halted

The method crm.company.details.configuration.set continues to function, but there is a more relevant alternative crm.item.details.configuration.set.

The method crm.company.details.configuration.set sets the settings for company cards: it records personal settings for the specified user or common settings 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` — common settings Default — `P`
userId `user`	User identifier, which can be obtained using the user.get method. Required only when setting personal settings. If not specified — the `id` of the current user is used
data* `section[]`	The list `section` describes the configuration of field sections in the company card. The structure is described below

section

Describes a specific section with fields within the company card.

Required parameters are marked with *

Name `type`	Description
name* `string`	Unique name of the section
title* `string`	Title of the section. Displayed in the item card
type* `string`	Type of the section. Currently, only the value `'section'` is available
elements `section_element[]`	The array `section_element` describes the configuration of fields in the section. The structure is described below

section_element

Configuration of a specific field within the section.

Required parameters are marked with *

Name `type`	Description
name* `string`	Field identifier. The list of available fields can be found using `crm.company.fields`
optionFlags `integer`	Whether to always show the field: `1` — yes `0` — no Default — `0`
options `object`	Additional options list for the field

section_element.options

Name
type

Fields where the option is available

Description

defaultAddressType
integer

ADDRESS

Identifier for the default address type. To find out possible address types, use crm.enum.addresstype

defaultCountry
string

PHONE
CLIENT
COMPANY
CONTACT
MYCOMPANY_ID

Country code for the default phone number format — a string of two Latin letters.

For example, "DE"

Code Examples

How to Use Examples in Documentation

For a user with id = 1, set the configuration for the company card:

Section 1 — About the Company
- Title
- Logo
- Company Type
- Position
- Phone
  - Default Country: Germany(+1)
- E-mail
- Contact
Section 2 — Additional
- Industry
- Is the company available to everyone
- Responsible**
- Comment

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"userId":1,"data":[{"name":"main","title":"About the Company","type":"section","elements":[{"name":"TITLE"},{"name":"LOGO"},{"name":"COMPANY_TYPE"},{"name":"POST"},{"name":"PHONE","options":{"defaultCountry":"DE"}},{"name":"EMAIL"},{"name":"CONTACT"}]},{"name":"additional","title":"Additional","type":"section","elements":[{"name":"INDUSTRY"},{"name":"OPENED"},{"name":"ASSIGNED_BY_ID"},{"name":"COMMENTS"}]}]}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.company.details.configuration.set

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"userId":1,"data":[{"name":"main","title":"About the Company","type":"section","elements":[{"name":"TITLE"},{"name":"LOGO"},{"name":"COMPANY_TYPE"},{"name":"POST"},{"name":"PHONE","options":{"defaultCountry":"DE"}},{"name":"EMAIL"},{"name":"CONTACT"}]},{"name":"additional","title":"Additional","type":"section","elements":[{"name":"INDUSTRY"},{"name":"OPENED"},{"name":"ASSIGNED_BY_ID"},{"name":"COMMENTS"}]}],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.company.details.configuration.set

try
        {
        	const response = await $b24.callMethod(
        		"crm.company.details.configuration.set",
        		{
        			userId: 1,
        			data:
        			[
        				{
        					name: "main",
        					title: "About the Company",
        					type: "section",
        					elements:
        					[
        						{ name: "TITLE" },
        						{ name: "LOGO" },
        						{ name: "COMPANY_TYPE" },
        						{ name: "POST" },
        					{
        						name: "PHONE",
        						options: {
        							defaultCountry: "DE",
        						},
        					},
        						{ name: "EMAIL" },
        						{ name: "CONTACT" }
        					]
        				},
        				{
        					name: "additional",
        					title: "Additional",
        					type: "section",
        					elements:
        					[
        						{ name: "INDUSTRY" },
        						{ name: "OPENED" },
        						{ name: "ASSIGNED_BY_ID" },
        						{ name: "COMMENTS" }
        					]
        				}
        			]
        		}
        	);
        	
        	const result = response.getData().result;
        	if(result.error())
        		console.error(result.error());
        	else
        		console.dir(result);
        }
        catch(error)
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.company.details.configuration.set',
                    [
                        'userId' => 1,
                        'data' => [
                            [
                                'name' => 'main',
                                'title' => 'About the Company',
                                'type' => 'section',
                                'elements' => [
                                    ['name' => 'TITLE'],
                                    ['name' => 'LOGO'],
                                    ['name' => 'COMPANY_TYPE'],
                                    ['name' => 'POST'],
                                    [
                                        'name' => 'PHONE',
                                        'options' => [
                                            'defaultCountry' => 'DE',
                                        ],
                                    ],
                                    ['name' => 'EMAIL'],
                                    ['name' => 'CONTACT']
                                ]
                            ],
                            [
                                'name' => 'additional',
                                'title' => 'Additional',
                                'type' => 'section',
                                'elements' => [
                                    ['name' => 'INDUSTRY'],
                                    ['name' => 'OPENED'],
                                    ['name' => 'ASSIGNED_BY_ID'],
                                    ['name' => 'COMMENTS']
                                ]
                            ]
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error setting company details configuration: ' . $e->getMessage();
        }

BX24.callMethod(
            "crm.company.details.configuration.set",
            {
                userId: 1,
                data:
                [
                    {
                        name: "main",
                        title: "About the Company",
                        type: "section",
                        elements:
                        [
                            { name: "TITLE" },
                            { name: "LOGO" },
                            { name: "COMPANY_TYPE" },
                            { name: "POST" },
                            {
                                name: "PHONE",
                                options: {
                                    defaultCountry: "DE",
                                },
                            },
                            { name: "EMAIL" },
                            { name: "CONTACT" }
                        ]
                    },
                    {
                        name: "additional",
                        title: "Additional",
                        type: "section",
                        elements:
                        [
                            { name: "INDUSTRY" },
                            { name: "OPENED" },
                            { name: "ASSIGNED_BY_ID" },
                            { name: "COMMENTS" }
                        ]
                    }
                ]
            },
            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.set',
            [
                'userId' => 1,
                'data' => [
                    [
                        'name' => 'main',
                        'title' => 'About the Company',
                        'type' => 'section',
                        'elements' => [
                            ['name' => 'TITLE'],
                            ['name' => 'LOGO'],
                            ['name' => 'COMPANY_TYPE'],
                            ['name' => 'POST'],
                            [
                                'name' => 'PHONE',
                                'options' => [
                                    'defaultCountry' => 'DE',
                                },
                            ],
                            ['name' => 'EMAIL'],
                            ['name' => 'CONTACT'],
                        ]
                    ],
                    [
                        'name' => 'additional',
                        'title' => 'Additional',
                        'type' => 'section',
                        'elements' => [
                            ['name' => 'INDUSTRY'],
                            ['name' => 'OPENED'],
                            ['name' => 'ASSIGNED_BY_ID'],
                            ['name' => 'COMMENTS'],
                        ]
                    ],
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

{
            "result": true,
            "time": {
                "start": 1769419970,
                "finish": 1769419970.57774,
                "duration": 0.577739953994751,
                "processing": 0,
                "date_start": "2026-01-26T12:32:50+01:00",
                "date_finish": "2026-01-26T12:32:50+01:00",
                "operating_reset_at": 1769420570,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `boolean`	Root element of the response, contains `true` in case of success
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	The user does not have permission to change CRM settings
`-`	Parameter 'data' must be array	A non-array was passed in `data`
`-`	The data must be indexed array	A non-indexed array was passed in `data`
`-`	There are no data to write	An empty array was passed in `data`
`-`	Section at index `#` have type `data[i].type`. The expected type is 'section'	The value in `data[i].type` is different from `'section'`
`-`	Section at index `#` does not have name	An empty value was passed in `data[i].name`
`-`	Section at index `#` does not have title	An empty value was passed in `data[i].title`
`-`	Element at index `#` in section at index `#` does not have name	An empty value was passed in `data[i].elements[j].name`

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.company.details.configuration.set

Method ParametersMethod Parameters

sectionsection

section_elementsection_element

section_element.optionssection_element.options

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

Method Parameters

section

section_element

section_element.options

Code Examples

Response Handling

Returned Data

Error Handling

Possible Error Codes

Statuses and System Error Codes

Continue Learning