Set Parameters for CRM Item Card crm.item.details.configuration.set

Method name: crm.item.details.configuration.set

Scope: crm

Who can execute the method: access permission checks depend on the provided data:

Any user can set their personal settings

A user can set common and others' settings only if they are an administrator

The method sets the settings for the card of a specific CRM object. It records personal settings for the specified user or common settings for all users.

Note

The settings for repeat lead detail forms may differ from those of simple lead detail forms. The parameter extras.leadCustomerType is used to switch between lead detail form settings.
The settings for the CRM entity detail form may vary depending on their Sales Funnel. The parameters used for switching are:
- extras.categoryId — for SPAs
- extras.dealCategoryId — for deals

Method Parameters

Required parameters are marked with *

Name `type`	Description
entityTypeId* `integer`	Identifier of the system or user-defined type of CRM objects
data* `section[]`	List of `section` describing the configuration of field sections in the item card. The structure of `section` is described below
userId `user`	Identifier of the user for whom you want to set the configuration. If the parameter is not provided, the `userId` of the user calling this method will be used. Required only when requesting personal settings
scope `string`	Scope of the settings. Allowed values: `'P'` — personal settings `'C'` — common settings By default, the value is `'P'`
extras `object`	Additional parameters. Possible values and their structure are described below

section

Describes a specific section with fields within the item 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[]`	Array of `section_element`, describing the configuration of fields in the section

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.item.fields`
optionFlags `integer`	Should the field always be shown: `1` — yes `0` — no By default, the value is `0`
options `object`	Additional options list for the field

section_element.options

Name `type`	Fields where the option is available	Description	Default
defaultAddressType `integer`	`ADDRESS`	Identifier of the default address type. To find possible address types, use `crm.enum.addresstype`	`Computed`
defaultCountry `string`	`PHONE` `CLIENT` `COMPANY` `CONTACT` `MYCOMPANY_ID`	Country code for the default phone number format — a string of two Latin letters. For example, `"GB"`	`Computed`
isPayButtonVisible `boolean`	`OPPORTUNITY_WITH_CURRENCY`	Is the payment acceptance button shown. Possible values: `'true'` — shown `'false'` — hidden	`'true'`
isPaymentDocumentsVisible `boolean`	`OPPORTUNITY_WITH_CURRENCY`	Is the "Payment and Delivery" block shown. Possible values: `'true'` — shown `'false'` — hidden	`'true'`

extras

The extras parameter depends on the CRM object.

CRM Object	Name	Description
SPA	`categoryId`	Identifier of the SPA funnel. Can be obtained using `crm.category.list`. If not specified, the default funnel identifier for this SPA will be used
Deal	`dealCategoryId`	Identifier of the deal funnel. Can be obtained using `crm.category.list`. If not specified, the default funnel identifier for deals will be used
Lead	`leadCustomerType`	Type of leads. Possible values: `1` — simple leads `2` — repeat leads

Code Examples

How to Use Examples in Documentation

For the user with id = 1, set the following configuration for the item card

Section 1 - Personal Data
- First Name
  - Show always
- Last Name
  - Show always
- Middle Name
- Date of Birth
- Phone
  - Show always
  - Default country: United Kingdom(+44)
- Address
  - Show always
  - Default address type: Registration Address (see crm.enum.addresstype)
Section 2 - Basic Information
- Contact Type
- Source
- Position
Section 3 - Additional Information
- Photo
- Comment
- Custom Field #1

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"entityTypeId":3,"userId":1,"data":[{"name":"section_1","title":"Personal Data","type":"section","elements":[{"name":"NAME","optionFlags":1},{"name":"LAST_NAME","optionFlags":1},{"name":"SECOND_NAME"},{"name":"BIRTHDATE"},{"name":"PHONE","optionFlags":1,"options":{"defaultCountry":"GB"}},{"name":"ADDRESS","optionFlags":1,"options":{"defaultAddressType":4}}]},{"name":"section_2","title":"Basic Information","type":"section","elements":[{"name":"TYPE_ID"},{"name":"SOURCE_ID"},{"name":"POST"}]},{"name":"section_3","title":"Additional Information","type":"section","elements":[{"name":"PHOTO"},{"name":"COMMENTS"},{"name":"UF_CRM_1720697698689"}]}]}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.item.details.configuration.set

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"entityTypeId":3,"userId":1,"data":[{"name":"section_1","title":"Personal Data","type":"section","elements":[{"name":"NAME","optionFlags":1},{"name":"LAST_NAME","optionFlags":1},{"name":"SECOND_NAME"},{"name":"BIRTHDATE"},{"name":"PHONE","optionFlags":1,"options":{"defaultCountry":"GB"}},{"name":"ADDRESS","optionFlags":1,"options":{"defaultAddressType":4}}]},{"name":"section_2","title":"Basic Information","type":"section","elements":[{"name":"TYPE_ID"},{"name":"SOURCE_ID"},{"name":"POST"}]},{"name":"section_3","title":"Additional Information","type":"section","elements":[{"name":"PHOTO"},{"name":"COMMENTS"},{"name":"UF_CRM_1720697698689"}]}],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.item.details.configuration.set

try
        {
        	const response = await $b24.callMethod(
        		'crm.item.details.configuration.set',
        		{
        			entityTypeId: 3,
        			userId: 1,
        			data: [
        				{
        					name: "section_1",
        					title: "Personal Data",
        					type: "section",
        					elements: [
        						{
        							name: "NAME",
        							optionFlags: 1,
        						},
        						{
        							name: "LAST_NAME",
        							optionFlags: 1,
        						},
        						{
        							name: "SECOND_NAME",
        						},
        						{
        							name: "BIRTHDATE",
        						},
        						{
        							name: "PHONE",
        							optionFlags: 1,
        							options: {
        								defaultCountry: "GB",
        							},
        						},
        						{
        							name: "ADDRESS",
        							optionFlags: 1,
        							options: {
        								defaultAddressType: 4,
        							},
        						},
        					],
        				},
        				{
        					name: "section_2",
        					title: "Basic Information",
        					type: "section",
        					elements: [
        						{ name: "TYPE_ID" },
        						{ name: "SOURCE_ID" },
        						{ name: "POST" },
        					],
        				},
        				{
        					name: "section_3",
        					title: "Additional Information",
        					type: "section",
        					elements: [
        						{ name: "PHOTO" },
        						{ name: "COMMENTS" },
        						{ name: "UF_CRM_1720697698689" },
        					],
        				},
        			],
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.item.details.configuration.set',
                    [
                        'entityTypeId' => 3,
                        'userId'       => 1,
                        'data'         => [
                            [
                                'name'     => "section_1",
                                'title'    => "Personal Data",
                                'type'     => "section",
                                'elements' => [
                                    [
                                        'name'        => "NAME",
                                        'optionFlags' => 1,
                                    ],
                                    [
                                        'name'        => "LAST_NAME",
                                        'optionFlags' => 1,
                                    ],
                                    [
                                        'name' => "SECOND_NAME",
                                    ],
                                    [
                                        'name' => "BIRTHDATE",
                                    ],
                                    [
                                        'name'     => "PHONE",
                                        'optionFlags' => 1,
                                        'options'  => [
                                            'defaultCountry' => "GB",
                                        ],
                                    ],
                                    [
                                        'name'     => "ADDRESS",
                                        'optionFlags' => 1,
                                        'options'  => [
                                            'defaultAddressType' => 4,
                                        ],
                                    ],
                                ],
                            ],
                            [
                                'name'     => "section_2",
                                'title'    => "Basic Information",
                                'type'     => "section",
                                'elements' => [
                                    ['name' => "TYPE_ID"],
                                    ['name' => "SOURCE_ID"],
                                    ['name' => "POST"],
                                ],
                            ],
                            [
                                'name'     => "section_3",
                                'title'    => "Additional Information",
                                'type'     => "section",
                                'elements' => [
                                    ['name' => "PHOTO"],
                                    ['name' => "COMMENTS"],
                                    ['name' => "UF_CRM_1720697698689"],
                                ],
                            ],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error setting details configuration: ' . $e->getMessage();
        }

    BX24.callMethod(
                'crm.item.details.configuration.set',
                {
                    entityTypeId: 3,
                    userId: 1,
                    data: [
                        {
                            name: "section_1",
                            title: "Personal Data",
                            type: "section",
                            elements: [
                                {
                                    name: "NAME",
                                    optionFlags: 1,
                                },
                                {
                                    name: "LAST_NAME",
                                    optionFlags: 1,
                                },
                                {
                                    name: "SECOND_NAME",
                                },
                                {
                                    name: "BIRTHDATE",
                                },
                                {
                                    name: "PHONE",
                                    optionFlags: 1,
                                    options: {
                                        defaultCountry: "GB",
                                    },
                                },
                                {
                                    name: "ADDRESS",
                                    optionFlags: 1,
                                    options: {
                                        defaultAddressType: 4,
                                    },
                                },
                            ],
                        },
                        {
                            name: "section_2",
                            title: "Basic Information",
                            type: "section",
                            elements: [
                                { name: "TYPE_ID" },
                                { name: "SOURCE_ID" },
                                { name: "POST" },
                            ],
                        },
                        {
                            name: "section_3",
                            title: "Additional Information",
                            type: "section",
                            elements: [
                                { name: "PHOTO" },
                                { name: "COMMENTS" },
                                { name: "UF_CRM_1720697698689" },
                            ],
                        },
                    ],
                },
                (result) => {
                    if (result.error())
                    {
                        console.error(result.error());
        
                        return;
                    }
        
                    console.info(result.data());
                },
            );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.item.details.configuration.set',
            [
                'entityTypeId' => 3,
                'userId' => 1,
                'data' => [
                    [
                        'name' => "section_1",
                        'title' => "Personal Data",
                        'type' => "section",
                        'elements' => [
                            [
                                'name' => "NAME",
                                'optionFlags' => 1,
                            ],
                            [
                                'name' => "LAST_NAME",
                                'optionFlags' => 1,
                            ],
                            [
                                'name' => "SECOND_NAME",
                            ],
                            [
                                'name' => "BIRTHDATE",
                            ],
                            [
                                'name' => "PHONE",
                                'optionFlags' => 1,
                                'options' => [
                                    'defaultCountry' => "GB",
                                ],
                            ],
                            [
                                'name' => "ADDRESS",
                                'optionFlags' => 1,
                                'options' => [
                                    'defaultAddressType' => 4,
                                ],
                            ],
                        ],
                    ],
                    [
                        'name' => "section_2",
                        'title' => "Basic Information",
                        'type' => "section",
                        'elements' => [
                            ['name' => "TYPE_ID"],
                            ['name' => "SOURCE_ID"],
                            ['name' => "POST"],
                        ],
                    ],
                    [
                        'name' => "section_3",
                        'title' => "Additional Information",
                        'type' => "section",
                        'elements' => [
                            ['name' => "PHOTO"],
                            ['name' => "COMMENTS"],
                            ['name' => "UF_CRM_1720697698689"],
                        ],
                    ],
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
            "result": true,
            "time": {
                "start": 1720699969.76157,
                "finish": 1720699970.153406,
                "duration": 0.39183592796325684,
                "processing": 0.02178215980529785,
                "date_start": "2024-07-11T14:12:49+02:00",
                "date_finish": "2024-07-11T14:12:50+02:00",
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `boolean`	Root element of the response. Returns `true` on 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
Empty value	Parameter 'entityTypeId' is not defined	Required parameter `entityTypeId` not provided
Empty value	The entity type '`entityTypeName`' is not supported in the current context.	The method does not support this entity type
Empty value	Access denied.	The user does not have administrative rights
Empty value	Parameter 'data' must be an array.	A non-array was provided in `data`
Empty value	The data must be an indexed array.	A non-indexed array was provided in `data`
Empty value	There are no data to write.	An empty array was provided in `data`
Empty value	Section at index `i` 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 `i` does not have a name.	An empty value was provided in `data[i].name`
Empty value	Section at index `i` does not have a title.	An empty value was provided in `data[i].title`
Empty value	Element at index `j` in section at index `i` does not have a name.	An empty value was provided 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

Get CRM Entity Detail Form Parameters

Reset CRM Entity Detail Form Parameters

Set Parameters for CRM Item Card crm.item.details.configuration.set

Method ParametersMethod Parameters

sectionsection

section_elementsection_element

section_element.optionssection_element.options

extrasextras

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

extras

Code Examples

Response Handling

Returned Data

Error Handling

Possible Error Codes

Statuses and System Error Codes

Continue Learning