Set Parameters for Individual Card crm.contact.details.configuration.set

Scope: crm

Who can execute the method:

Any user has the right to retrieve their own and common settings

Only an administrator has the right to retrieve others' settings

Method Development Stopped

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

The method sets the contact card settings: it writes 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. Required only when setting personal settings. If not specified — takes the `id` of the current user
data* `section[]`	The list `section` describes the configuration of the field sections in the item card. The structure is described below

section

Describes a specific section with fields within the contact 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.contact.fields`
optionFlags `integer`	Whether to always show the field: `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 of the default address type. To find 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, `"GB"`
isPayButtonVisible `boolean`	`OPPORTUNITY_WITH_CURRENCY`	Whether the payment acceptance button is shown. Possible values: `'true'` — shown `'false'` — hidden Default — `true`
isPaymentDocumentsVisible `boolean`	`OPPORTUNITY_WITH_CURRENCY`	Whether the "Payment and Delivery" block is shown. Possible values: `'true'` — shown `'false'` — hidden Default — `true`

Code Examples

How to Use Examples in Documentation

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

Section 1 — Personal Data
- First Name
  - Always show
- Last Name
  - Always show
- Middle Name
- Date of Birth
- Phone
  - Always show
  - Default country: United Kingdom (+44)
- Address
  - Always show
  - Default address type: Registration Address (see crm.enum.addresstype)
Section 2 — Main 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 '{"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":"Main 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.contact.details.configuration.set

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"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":"Main 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.contact.details.configuration.set

try
        {
        	const response = await $b24.callMethod(
        		'crm.contact.details.configuration.set',
        		{
        			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: "Main 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;
        	result.error()
        		? console.error(result.error())
        		: console.info(result)
        	;
        }
        catch( error )
        {
        	console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.contact.details.configuration.set',
                    [
                        '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'    => "Main 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();
        
            if ($response->getError()) {
                echo 'Error: ' . $response->getError();
            } else {
                echo 'Success: ' . print_r($result, true);
                // Your logic for processing data
                processData($result);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error setting contact details configuration: ' . $e->getMessage();
        }

BX24.callMethod(
            'crm.contact.details.configuration.set',
            {
                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: "Main 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) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.contact.details.configuration.set',
            [
                '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' => 'Main 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": 1724677217.639681,
                "finish": 1724677217.986853,
                "duration": 0.3471717834472656,
                "processing": 0.01840806007385254,
                "date_start": "2024-08-26T15:00:17+02:00",
                "date_finish": "2024-08-26T15:00:17+02:00",
                "operating": 0
            }
        }

Returned Values

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	Access denied.	The user does not have administrative rights
Empty value	Parameter 'data' must be array.	A non-array 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 `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 name.	An empty value was passed in `data[i].name`
Empty value	Section at index `i` does not have title.	An empty value was passed in `data[i].title`
Empty value	Element at index `j` in section at index `i` 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

Get Card Parameters

Set Common Card for All Users

Set Parameters for Individual Card crm.contact.details.configuration.set

Method ParametersMethod Parameters

sectionsection

section_elementsection_element

section_element.optionssection_element.options

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned ValuesReturned Values

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 Values

Error Handling

Possible Error Codes

Statuses and System Error Codes

Continue Learning