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

Choose a tool for developing with an AI agent:

use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

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

DEPRECATED

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

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

Note

The settings for deal cards in different Sales Funnels may vary. To select a Sales 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 is `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)

Parameter extras Parameter

Required parameters are marked with *

Name
type

Description

dealCategoryId
integer

Identifier of the deal 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`	Whether to always show the field: `1` — yes `0` — no Default is `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)

JS (TS)

JS (UMD)

Python

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

// 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.deal.details.configuration.set',
            params: {
              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',
                  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' },
                  ],
                },
              ],
            },
            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 setDealCardConfiguration() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'crm.deal.details.configuration.set',
                params: {
                  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',
                      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' },
                      ],
                    },
                  ],
                },
                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', setDealCardConfiguration)
        </script>


        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.deal.details.configuration.set(
                scope="P",
                user_id=1,
                extras={"dealCategoryId": 0},
            ).response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected 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>';

// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "crm.deal.details.configuration.set", b24.Params{
        	"scope":  "P",
        	"userId": 1,
        	"extras": b24.Params{
        		"dealCategoryId": 32,
        	},
        	"data": []b24.Params{
        		{
        			"name":  "main",
        			"title": "About the Deal",
        			"type":  "section",
        			"elements": []b24.Params{
        				{
        					"name": "TITLE",
        				},
        				{
        					"name": "OPPORTUNITY_WITH_CURRENCY",
        				},
        				{
        					"name": "STAGE_ID",
        				},
        				{
        					"name": "CLOSEDATE",
        				},
        				{
        					"name": "CLIENT",
        				},
        			},
        		},
        		{
        			"name":  "additional",
        			"title": "Additional Information",
        			"type":  "section",
        			"elements": []b24.Params{
        				{
        					"name": "TYPE_ID",
        				},
        				{
        					"name": "SOURCE_ID",
        				},
        				{
        					"name": "SOURCE_DESCRIPTION",
        				},
        				{
        					"name": "OPENED",
        				},
        				{
        					"name": "ASSIGNED_BY_ID",
        				},
        				{
        					"name": "COMMENTS",
        				},
        			},
        		},
        		{
        			"name":  "products",
        			"title": "Products",
        			"type":  "section",
        			"elements": []b24.Params{
        				{
        					"name": "PRODUCT_ROW_SUMMARY",
        				},
        			},
        		},
        	},
        })
        if err != nil {
        	return fmt.Errorf("crm.deal.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": 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 execution time of the request

Error Handling

HTTP Status: 400

{
            "error": "",
            "error_description": "Access denied."
        }

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

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'	The value in `data[i].type` is different from `section`
`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: 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	REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. 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?

Get Deal Card Parameters

Reset Deal Card Parameters

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

Method ParametersMethod Parameters

Parameter extras ParameterParameter extras 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

Was the article helpful?

Method Parameters

Parameter 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