Set Parameters for the Individual Card crm.contact.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:
crmWho can execute the method:
- Any user has the right to access their own and shared settings
- Only an administrator has the right to access others' settings
DEPRECATED
The development of this method has been halted. Please use crm.item.details.configuration.set.
This method sets the contact card settings: it writes personal settings for the specified user or shared settings for all users.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
scope |
The scope of the settings. Possible values:
Default — |
|
userId |
User identifier. Required only when setting personal settings. If not specified, the |
|
data* |
The list of The structure is described below |
section
Describes an individual section with fields within the contact card.
Required parameters are marked with *
|
Name |
Description |
|
name* |
Unique name of the section |
|
title* |
Title of the section. Displayed in the item card |
|
type* |
Type of the section. Currently, only the value |
|
elements |
The array The structure is described below |
section_element
Configuration of an individual field within the section.
Required parameters are marked with *
|
Name |
Description |
|
name* |
Field identifier. The list of available fields can be obtained using |
|
optionFlags |
Should the field always be displayed:
Default — |
|
options |
Additional list of options for the field |
section_element.options
|
Name |
Fields where the option is available |
Description |
|
defaultAddressType |
|
Identifier for the default address type. To find possible address types, use |
|
defaultCountry |
|
Country code for the default phone number format — a string of two Latin letters. For example, |
|
isPayButtonVisible |
|
Whether the payment acceptance button is displayed. Possible values:
Default — |
|
isPaymentDocumentsVisible |
|
Whether the "Payment and Delivery" block is displayed. Possible values:
Default — |
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)
- First Name
- Section 2 — Main Information
- Contact Type
- Source
- Position
- Section 3 — Additional Information
- Photo
- Comment
- Custom Field #1
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
// 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.contact.details.configuration.set',
params: {
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' },
],
},
],
},
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 setContactDetailsConfiguration() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.contact.details.configuration.set',
params: {
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' },
],
},
],
},
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', setContactDetailsConfiguration)
</script>
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 data processing logic here
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 |
Description |
|
result |
The root element of the response. Returns |
|
time |
Information about the request execution time |
Error Handling
HTTP Status: 400
{
"error": "",
"error_description": "Element at index 0 in section at index 1 does not have name."
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
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 |
|
Empty Value |
The data must be indexed array. |
A non-indexed array was passed in |
|
Empty Value |
There are no data to write. |
An empty array was passed in |
|
Empty Value |
Section at index |
A value other than |
|
Empty Value |
Section at index |
An empty value was passed in |
|
Empty Value |
Section at index |
An empty value was passed in |
|
Empty Value |
Element at index |
An empty value was passed in |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only |
|
|
|
The public part of the site is closed. To open the public part of the site 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 |