Set Parameters for the Individual Card crm.contact.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:
crmWho can execute the method:
- any user can set their own personal settings
- a user with the "Allow to change settings" access permission in CRM can set the shared settings and another user's personal 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>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "crm.contact.details.configuration.set", b24.Params{
"userId": 1,
"data": []b24.Params{
{
"name": "section_1",
"title": "Personal Data",
"type": "section",
"elements": []b24.Params{
{
"name": "NAME",
"optionFlags": 1,
},
{
"name": "LAST_NAME",
"optionFlags": 1,
},
{
"name": "SECOND_NAME",
},
{
"name": "BIRTHDATE",
},
{
"name": "PHONE",
"optionFlags": 1,
"options": b24.Params{
"defaultCountry": "GB",
},
},
{
"name": "ADDRESS",
"optionFlags": 1,
"options": b24.Params{
"defaultAddressType": 4,
},
},
},
},
{
"name": "section_2",
"title": "Main Information",
"type": "section",
"elements": []b24.Params{
{
"name": "TYPE_ID",
},
{
"name": "SOURCE_ID",
},
{
"name": "POST",
},
},
},
{
"name": "section_3",
"title": "Additional Information",
"type": "section",
"elements": []b24.Params{
{
"name": "PHOTO",
},
{
"name": "COMMENTS",
},
{
"name": "UF_CRM_1720697698689",
},
},
},
},
})
if err != nil {
return fmt.Errorf("crm.contact.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": 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 consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
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: 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 |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
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 |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
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 — |
|
|
|
No active webhook with the specified user identifier and secret code was 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 |
|
|
|
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 |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
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 |