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

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

DEPRECATED

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

The method crm.company.details.configuration.set sets the settings for company cards: it records the personal settings of the specified user or the 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`	The 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 of `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`	Should the field always be displayed: `1` — yes `0` — no Default — `0`
options `object`	Additional list of options 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

To set the card configuration for a user with id = 1 in companies:

Section 1 — About the Company
- Name
- 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)

JS (TS)

JS (UMD)

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

// 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.company.details.configuration.set',
            params: {
              userId: 1,
              data: [
                {
                  name: 'main',
                  title: 'About company',
                  type: 'section',
                  elements: [
                    { name: 'TITLE' },
                    { name: 'LOGO' },
                    { name: 'COMPANY_TYPE' },
                    { name: 'POST' },
                    {
                      name: 'PHONE',
                      options: {
                        defaultCountry: 'RU',
                      },
                    },
                    { name: 'EMAIL' },
                    { name: 'CONTACT' },
                  ],
                },
                {
                  name: 'additional',
                  title: 'Additional',
                  type: 'section',
                  elements: [
                    { name: 'INDUSTRY' },
                    { name: 'OPENED' },
                    { 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 setCompanyDetailsConfiguration() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'crm.company.details.configuration.set',
                params: {
                  userId: 1,
                  data: [
                    {
                      name: 'main',
                      title: 'About company',
                      type: 'section',
                      elements: [
                        { name: 'TITLE' },
                        { name: 'LOGO' },
                        { name: 'COMPANY_TYPE' },
                        { name: 'POST' },
                        {
                          name: 'PHONE',
                          options: {
                            defaultCountry: 'RU',
                          },
                        },
                        { name: 'EMAIL' },
                        { name: 'CONTACT' },
                      ],
                    },
                    {
                      name: 'additional',
                      title: 'Additional',
                      type: 'section',
                      elements: [
                        { name: 'INDUSTRY' },
                        { name: 'OPENED' },
                        { 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', setCompanyDetailsConfiguration)
        </script>

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>';

// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "crm.company.details.configuration.set", b24.Params{
        	"userId": 1,
        	"data": []b24.Params{
        		{
        			"name":  "main",
        			"title": "About the Company",
        			"type":  "section",
        			"elements": []b24.Params{
        				{
        					"name": "TITLE",
        				},
        				{
        					"name": "LOGO",
        				},
        				{
        					"name": "COMPANY_TYPE",
        				},
        				{
        					"name": "POST",
        				},
        				{
        					"name": "PHONE",
        					"options": b24.Params{
        						"defaultCountry": "RU",
        					},
        				},
        				{
        					"name": "EMAIL",
        				},
        				{
        					"name": "CONTACT",
        				},
        			},
        		},
        		{
        			"name":  "additional",
        			"title": "Additional",
        			"type":  "section",
        			"elements": []b24.Params{
        				{
        					"name": "INDUSTRY",
        				},
        				{
        					"name": "OPENED",
        				},
        				{
        					"name": "ASSIGNED_BY_ID",
        				},
        				{
        					"name": "COMMENTS",
        				},
        			},
        		},
        	},
        })
        if err != nil {
        	return fmt.Errorf("crm.company.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": 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`	The 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 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	The user does not have permission to change CRM settings
Empty value	Parameter 'data' must be array	A non-array value was passed in `data`
Empty value	The data must be indexed array	A non-indexed array was passed in `data`
Empty value	There are no data to write	An empty array was passed in `data`
Empty value	Section at index `#` has type `data[i].type`. The expected type is 'section'	The value in `data[i].type` is different from `'section'`
Empty value	Section at index `#` does not have name	An empty value was passed in `data[i].name`
Empty value	Section at index `#` does not have title	An empty value was passed in `data[i].title`
Empty value	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: 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	The REST API is available only on commercial plans. 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.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

Was the article helpful?

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