Set Parameters for the Deal Card crm.deal.details.configuration.set

Scope: crm

Who can execute the method:

a user can set their personal settings

personal settings for another user can be set if the user has editing rights for that user's personal view

general settings can be set if the user has editing rights for the common view

Method Development Halted

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

The method crm.deal.details.configuration.set sets the settings for the deal card. This method records personal settings for the specified user or general settings for all users.

Note

Settings for deal cards may vary across different Sales Funnels. To select a funnel, use the extras.dealCategoryId parameter.

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 — `P`
userId `user`	User identifier. Required only when setting personal settings for another user. If not specified, the current user is used.
data* `section[]`	A list of `section` describing the configuration of the deal card sections. The structure of `section` is described below.
extras `object`	Additional parameters (detailed description)

Extras Parameter

Required parameters are marked with *

Name
type

Description

dealCategoryId
integer

Identifier for the Sales Funnel. Can be obtained using crm.category.list

If not specified, the default funnel for deals is used.

Section Parameter

Describes an individual section with fields within the deal card.

Required parameters are marked with *

Name `type`	Description
name* `string`	Unique name of the section.
title* `string`	Title of the section.
type* `string`	Type of the section. Currently, only the value `section` is available.
elements `section_element[]`	List of fields displayed in the card with additional settings.

Section Element Parameter

Configuration of an individual field within the section.

Required parameters are marked with *

Name `type`	Description
name* `string`	Field identifier. A list of available fields can be found using `crm.deal.fields`.
optionFlags `integer`	Should the field always be displayed: `1` — yes `0` — no Default — `0`
options `object`	Additional options for the field. The composition depends on the field.

Code Examples

How to Use Examples in Documentation

Set personal configuration for the deal card for the user with id = 1 in the funnel with id = 32.

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,"extras":{"dealCategoryId":32},"data":[{"name":"main","title":"About the Deal","type":"section","elements":[{"name":"TITLE"},{"name":"OPPORTUNITY_WITH_CURRENCY"},{"name":"STAGE_ID"},{"name":"CLOSEDATE"},{"name":"CLIENT"}]},{"name":"additional","title":"Additional Information","type":"section","elements":[{"name":"TYPE_ID"},{"name":"SOURCE_ID"},{"name":"SOURCE_DESCRIPTION"},{"name":"OPENED"},{"name":"ASSIGNED_BY_ID"},{"name":"COMMENTS"}]},{"name":"products","title":"Products","type":"section","elements":[{"name":"PRODUCT_ROW_SUMMARY"}]}]}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.deal.details.configuration.set

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"scope":"P","userId":1,"extras":{"dealCategoryId":32},"data":[{"name":"main","title":"About the Deal","type":"section","elements":[{"name":"TITLE"},{"name":"OPPORTUNITY_WITH_CURRENCY"},{"name":"STAGE_ID"},{"name":"CLOSEDATE"},{"name":"CLIENT"}]},{"name":"additional","title":"Additional Information","type":"section","elements":[{"name":"TYPE_ID"},{"name":"SOURCE_ID"},{"name":"SOURCE_DESCRIPTION"},{"name":"OPENED"},{"name":"ASSIGNED_BY_ID"},{"name":"COMMENTS"}]},{"name":"products","title":"Products","type":"section","elements":[{"name":"PRODUCT_ROW_SUMMARY"}]}],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.deal.details.configuration.set

try
        {
        	const response = await $b24.callMethod(
        		'crm.deal.details.configuration.set',
        		{
        			scope: "P",
        			userId: 1,
        			extras: {
        				dealCategoryId: 32,
        			},
        			data: [
        				{
        					name: "main",
        					title: "About the Deal",
        					type: "section",
        					elements: [
        						{ name: "TITLE" },
        						{ name: "OPPORTUNITY_WITH_CURRENCY" },
        						{ name: "STAGE_ID" },
        						{ name: "CLOSEDATE" },
        						{ name: "CLIENT" },
        					],
        				},
        				{
        					name: "additional",
        					title: "Additional Information",
        					type: "section",
        					elements: [
        						{ name: "TYPE_ID" },
        						{ name: "SOURCE_ID" },
        						{ name: "SOURCE_DESCRIPTION" },
        						{ name: "OPENED" },
        						{ name: "ASSIGNED_BY_ID" },
        						{ name: "COMMENTS" },
        					],
        				},
        				{
        					name: "products",
        					title: "Products",
        					type: "section",
        					elements: [
        						{ name: "PRODUCT_ROW_SUMMARY" },
        					],
        				},
        			],
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.deal.details.configuration.set',
                    [
                        'scope'  => 'P',
                        'userId' => 1,
                        'extras' => [
                            'dealCategoryId' => 32,
                        ],
                        'data' => [
                            [
                                'name'     => 'main',
                                'title'    => 'About the Deal',
                                'type'     => 'section',
                                'elements' => [
                                    ['name' => 'TITLE'],
                                    ['name' => 'OPPORTUNITY_WITH_CURRENCY'],
                                    ['name' => 'STAGE_ID'],
                                    ['name' => 'CLOSEDATE'],
                                    ['name' => 'CLIENT'],
                                ],
                            ],
                            [
                                'name'     => 'additional',
                                'title'    => 'Additional Information',
                                'type'     => 'section',
                                'elements' => [
                                    ['name' => 'TYPE_ID'],
                                    ['name' => 'SOURCE_ID'],
                                    ['name' => 'SOURCE_DESCRIPTION'],
                                    ['name' => 'OPENED'],
                                    ['name' => 'ASSIGNED_BY_ID'],
                                    ['name' => 'COMMENTS'],
                                ],
                            ],
                            [
                                'name'     => 'products',
                                'title'    => 'Products',
                                'type'     => 'section',
                                'elements' => [
                                    ['name' => 'PRODUCT_ROW_SUMMARY'],
                                ],
                            ],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                echo 'Error: ' . $result->error();
            } else {
                echo 'Data: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error setting deal details configuration: ' . $e->getMessage();
        }

BX24.callMethod(
            'crm.deal.details.configuration.set',
            {
                scope: "P",
                userId: 1,
                extras: {
                    dealCategoryId: 32,
                },
                data: [
                    {
                        name: "main",
                        title: "About the Deal",
                        type: "section",
                        elements: [
                            { name: "TITLE" },
                            { name: "OPPORTUNITY_WITH_CURRENCY" },
                            { name: "STAGE_ID" },
                            { name: "CLOSEDATE" },
                            { name: "CLIENT" },
                        ],
                    },
                    {
                        name: "additional",
                        title: "Additional Information",
                        type: "section",
                        elements: [
                            { name: "TYPE_ID" },
                            { name: "SOURCE_ID" },
                            { name: "SOURCE_DESCRIPTION" },
                            { name: "OPENED" },
                            { name: "ASSIGNED_BY_ID" },
                            { name: "COMMENTS" },
                        ],
                    },
                    {
                        name: "products",
                        title: "Products",
                        type: "section",
                        elements: [
                            { name: "PRODUCT_ROW_SUMMARY" },
                        ],
                    },
                ],
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.deal.details.configuration.set',
            [
                'scope' => 'P',
                'userId' => 1,
                'extras' => [
                    'dealCategoryId' => 32,
                ],
                'data' => [
                    [
                        'name' => 'main',
                        'title' => 'About the Deal',
                        'type' => 'section',
                        'elements' => [
                            ['name' => 'TITLE'],
                            ['name' => 'OPPORTUNITY_WITH_CURRENCY'],
                            ['name' => 'STAGE_ID'],
                            ['name' => 'CLOSEDATE'],
                            ['name' => 'CLIENT'],
                        ],
                    ],
                    [
                        'name' => 'additional',
                        'title' => 'Additional Information',
                        'type' => 'section',
                        'elements' => [
                            ['name' => 'TYPE_ID'],
                            ['name' => 'SOURCE_ID'],
                            ['name' => 'SOURCE_DESCRIPTION'],
                            ['name' => 'OPENED'],
                            ['name' => 'ASSIGNED_BY_ID'],
                            ['name' => 'COMMENTS'],
                        ],
                    ],
                    [
                        'name' => 'products',
                        'title' => 'Products',
                        'type' => 'section',
                        'elements' => [
                            ['name' => 'PRODUCT_ROW_SUMMARY'],
                        ],
                    ],
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

{
            "result": true,
            "time": {
                "start": 1773311825,
                "finish": 1773311825.969825,
                "duration": 0.969825029373169,
                "processing": 0,
                "date_start": "2026-03-12T13:37:05+01:00",
                "date_finish": "2026-03-12T13:37:05+01:00",
                "operating_reset_at": 1773312425,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `boolean`	Root element of the response. Returns `true` if the settings were successfully recorded.
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

Status	Code	Description	Value
`400`	Empty Value	Access denied	No rights to set deal card settings.
`400`	Empty Value	Parameter 'data' must be array	A non-array was passed in `data`.
`400`	Empty Value	There are no data to write	An empty array was passed in `data`.
`400`	Empty Value	The data must be indexed array	A non-indexed array was passed in `data`.
`400`	Empty Value	Section at index `i` has type `data[i].type`. The expected type is 'section'	A value other than `section` is found in `data[i].type`.
`400`	Empty Value	Section at index `i` does not have a name	An empty value was passed in `data[i].name`.
`400`	Empty Value	Section at index `i` does not have a title	An empty value was passed in `data[i].title`.
`400`	Empty Value	Element at index `j` in section at index `i` does not have a 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

Get Deal Card Parameters

Reset Deal Card Parameters

Set Parameters for the Deal Card crm.deal.details.configuration.set

Method ParametersMethod Parameters

Extras ParameterExtras Parameter

Section ParameterSection Parameter

Section Element ParameterSection Element 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

Method Parameters

Extras Parameter

Section Parameter

Section Element Parameter

Code Examples

Response Handling

Returned Data

Error Handling

Possible Error Codes

Statuses and System Error Codes

Continue Learning