Создать дополнительный вид карточки v 3.0 crm.<тип>.detailpagelayout.add
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
crmКто может выполнять метод: пользователь с правом изменять общий вид карточки этого типа объекта, например администратор CRM
Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.
Метод crm.<тип>.detailpagelayout.add создает дополнительный вид карточки элемента CRM и возвращает его идентификатор. Тип объекта задает сегмент <тип> в имени метода.
Дополнительный вид — набор разделов и полей карточки с названием и списком участников, которым он доступен. Участник может выбрать вид в карточке, или вид назначают методом crm.<тип>.detailpagelayout.setcurrent. После создания вид не становится текущим ни для кого.
Имя метода для типа объекта
|
Тип объекта |
Метод |
|
Сделка |
|
|
Лид |
|
|
Контакт |
|
|
Компания |
|
|
Предложение |
|
|
Счет |
|
|
Документ CRM |
|
|
Документ КЭДО |
|
|
Смарт-процесс |
|
Для смарт-процесса в имя метода подставляется идентификатор его типа entityTypeId. Идентификаторы типов можно получить методом crm.type.list. Методы видов карточки есть у смарт-процесса при любых настройках типа. У моей компании этих методов нет.
Имя метода пишется в нижнем регистре: crm.deal.detailpagelayout.add, а не crm.deal.detailPageLayout.add. На имя в другом регистре метод отвечает ошибкой «Метод не найден».
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
categoryId* |
Идентификатор воронки. Виды карточки хранятся отдельно для каждой воронки. Значение зависит от типа объекта:
Идентификаторы воронок сделок, контактов, компаний и смарт-процессов можно получить методом crm.<тип>.category.list |
|
fields* |
Поля нового вида (подробное описание) |
Параметр fields
Обязательные параметры отмечены *
|
Название |
Описание |
|
name* |
Название вида, до 100 символов. Пробелы в начале и в конце метод обрезает |
|
configuration* |
Разделы карточки в порядке вывода, хотя бы один раздел (подробное описание) |
|
audience* |
Участники, которым доступен вид, хотя бы один (подробное описание). Пользователя, который создает вид, метод добавляет в аудиторию сам |
Параметр configuration
Массив разделов карточки в порядке вывода. Каждый раздел — объект:
Обязательные параметры отмечены *
|
Название |
Описание |
|
name* |
Код раздела, уникальный в пределах вида, например |
|
title* |
Заголовок раздела в карточке |
|
elements* |
Поля раздела в порядке вывода (подробное описание). Можно передать пустой массив |
Поле раздела
|
Название |
Описание |
|
name* |
Имя поля в карточке: |
|
optionFlags |
Показывать ли поле, когда оно не заполнено. Возможные значения:
|
|
options |
Настройки поля в формате |
Метод не проверяет, есть ли поле с таким именем у типа объекта: вид с неизвестным именем поля сохранится. Готовые имена полей и их настройки возьмите из конфигурации общего вида — ее возвращает метод crm.<тип>.detailpagelayout.get с идентификатором из crm.<тип>.detailpagelayout.getcommonlayoutid.
Параметр audience
Массив участников, которым доступен дополнительный вид. Участник — объект:
Обязательные параметры отмечены *
|
Название |
Описание |
|
type* |
Тип участника. Возможные значения:
|
|
id* |
Идентификатор участника, положительное число |
В аудитории может быть до 1000 участников.
Примеры кода
Как использовать примеры в документации
Вызов нового API отличается добавлением параметра /api/ в запросе:
https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/crm.smartprocess1038.detailpagelayout.add
Примеры создают дополнительный вид карточки смарт-процесса с идентификатором типа 1038 в воронке по умолчанию. Вид с одним разделом доступен отделу с идентификатором 47. Для другого типа объекта замените имя метода по таблице выше.
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"categoryId":0,"fields":{"name":"Карточка для отдела закупок","configuration":[{"name":"main","title":"О заявке","elements":[{"name":"TITLE"},{"name":"STAGE_ID"},{"name":"OPPORTUNITY_WITH_CURRENCY"},{"name":"ASSIGNED_BY_ID"}]}],"audience":[{"type":"department","id":47}]}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/crm.smartprocess1038.detailpagelayout.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"categoryId":0,"fields":{"name":"Карточка для отдела закупок","configuration":[{"name":"main","title":"О заявке","elements":[{"name":"TITLE"},{"name":"STAGE_ID"},{"name":"OPPORTUNITY_WITH_CURRENCY"},{"name":"ASSIGNED_BY_ID"}]}],"audience":[{"type":"department","id":47}]},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/crm.smartprocess1038.detailpagelayout.add
Методы CRM пока не входят в список методов REST 3.0, который знает $b24.actions.v3.call.make: такой вызов вернет ошибку SDK JSSDK_CORE_METHOD_NOT_SUPPORT_IN_API_V3. Вызывайте метод через HTTP-клиент REST 3.0 — $b24.getHttpClient(ApiVersion.v3).call.
import { ApiVersion, Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type LayoutAddResult = {
id: number
}
try {
const response = await $b24.getHttpClient(ApiVersion.v3).call<LayoutAddResult>(
'crm.smartprocess1038.detailpagelayout.add',
{
categoryId: 0,
fields: {
name: 'Карточка для отдела закупок',
configuration: [
{
name: 'main',
title: 'О заявке',
elements: [
{ name: 'TITLE' },
{ name: 'STAGE_ID' },
{ name: 'OPPORTUNITY_WITH_CURRENCY' },
{ name: 'ASSIGNED_BY_ID' },
],
},
],
audience: [
{ type: 'department', id: 47 },
],
},
},
Text.getUuidRfc4122()
)
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Layout created:', result.id)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
Методы CRM пока не входят в список методов REST 3.0, который знает $b24.actions.v3.call.make. Вызывайте метод через HTTP-клиент REST 3.0 — $b24.getHttpClient(B24Js.ApiVersion.v3).call.
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function addLayout() {
try {
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.getHttpClient(B24Js.ApiVersion.v3).call(
'crm.smartprocess1038.detailpagelayout.add',
{
categoryId: 0,
fields: {
name: 'Карточка для отдела закупок',
configuration: [
{
name: 'main',
title: 'О заявке',
elements: [
{ name: 'TITLE' },
{ name: 'STAGE_ID' },
{ name: 'OPPORTUNITY_WITH_CURRENCY' },
{ name: 'ASSIGNED_BY_ID' },
],
},
],
audience: [
{ type: 'department', id: 47 },
],
},
},
B24Js.Text.getUuidRfc4122()
)
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Layout created:', result.id)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addLayout)
</script>
У методов CRM нет готовых оберток в b24pysdk, и SDK отправляет в REST 3.0 только методы из списка Config().api_v3_methods. Добавьте метод в этот список и вызовите его через bitrix_token.call_method с prefer_version=3.
from b24pysdk import Config
from b24pysdk.errors import BitrixSDKException
from b24pysdk.errors.v3 import BitrixAPIError
method = "crm.smartprocess1038.detailpagelayout.add"
Config().configure(api_v3_methods=Config().api_v3_methods | {method})
try:
response = bitrix_token.call_method(
api_method=method,
params={
"categoryId": 0,
"fields": {
"name": "Карточка для отдела закупок",
"configuration": [
{
"name": "main",
"title": "О заявке",
"elements": [
{"name": "TITLE"},
{"name": "STAGE_ID"},
{"name": "OPPORTUNITY_WITH_CURRENCY"},
{"name": "ASSIGNED_BY_ID"},
],
},
],
"audience": [
{"type": "department", "id": 47},
],
},
},
prefer_version=3,
)
result = response["result"]
print(result["id"])
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"code: {error.code}",
f"message: {error.error.message}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.
try {
$response = $b24Service
->core
->call(
'crm.smartprocess1038.detailpagelayout.add',
[
'categoryId' => 0,
'fields' => [
'name' => 'Карточка для отдела закупок',
'configuration' => [
[
'name' => 'main',
'title' => 'О заявке',
'elements' => [
['name' => 'TITLE'],
['name' => 'STAGE_ID'],
['name' => 'OPPORTUNITY_WITH_CURRENCY'],
['name' => 'ASSIGNED_BY_ID'],
],
],
],
'audience' => [
['type' => 'department', 'id' => 47],
],
],
]
);
$result = $response
->getResponseData()
->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.
BX24.callMethod(
'crm.smartprocess1038.detailpagelayout.add',
{
categoryId: 0,
fields: {
name: 'Карточка для отдела закупок',
configuration: [
{
name: 'main',
title: 'О заявке',
elements: [
{ name: 'TITLE' },
{ name: 'STAGE_ID' },
{ name: 'OPPORTUNITY_WITH_CURRENCY' },
{ name: 'ASSIGNED_BY_ID' },
],
},
],
audience: [
{ type: 'department', id: 47 },
],
},
},
result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.
require_once('crest.php');
$result = CRest::call(
'crm.smartprocess1038.detailpagelayout.add',
[
'categoryId' => 0,
'fields' => [
'name' => 'Карточка для отдела закупок',
'configuration' => [
[
'name' => 'main',
'title' => 'О заявке',
'elements' => [
['name' => 'TITLE'],
['name' => 'STAGE_ID'],
['name' => 'OPPORTUNITY_WITH_CURRENCY'],
['name' => 'ASSIGNED_BY_ID'],
],
],
],
'audience' => [
['type' => 'department', 'id' => 47],
],
],
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.smartprocess1038.detailpagelayout.add", b24.Params{
"categoryId": 0,
"fields": b24.Params{
"name": "Карточка для отдела закупок",
"configuration": []b24.Params{
{
"name": "main",
"title": "О заявке",
"elements": []b24.Params{
{"name": "TITLE"},
{"name": "STAGE_ID"},
{"name": "OPPORTUNITY_WITH_CURRENCY"},
{"name": "ASSIGNED_BY_ID"},
},
},
},
"audience": []b24.Params{
{"type": "department", "id": 47},
},
},
})
if err != nil {
return fmt.Errorf("crm.smartprocess1038.detailpagelayout.add: %w", err)
}
var created struct {
ID int `json:"id"`
}
if err := json.Unmarshal(res.Result, &created); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(created.ID)
Обработка ответа
HTTP-статус: 200
{
"result": {
"id": 17
},
"time": {
"start": 1793706619,
"finish": 1793706619.389998,
"duration": 0.3899979591369629,
"processing": 0,
"date_start": "2026-11-03T14:50:19+03:00",
"date_finish": "2026-11-03T14:50:19+03:00",
"operating_reset_at": 1793707200,
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Объект с данными ответа |
|
result.id |
Идентификатор созданного вида. В других методах он передается строкой, например |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION",
"message": "Ошибка при валидации объекта",
"validation": [
{
"message": "Не заполнено обязательное поле \"name\"",
"field": "name"
}
]
}
}
|
Название |
Описание |
|
error.code |
Строковый код ошибки. Используйте для идентификации типа исключения |
|
error.message |
Текстовое описание ошибки |
|
error.validation |
Массив c деталями ошибки. Присутствует только в ошибках валидации данных |
|
error.validation[].field |
Название поля, в котором возникла ошибка валидации |
|
error.validation[].message |
Описание ошибки, связанной с указанным полем |
Возможные коды ошибок
Ошибки видов карточки приходят с короткими кодами без префикса BITRIX_REST_V3_, например LAYOUT_NOT_FOUND, и с текстом на английском языке. HTTP-статус у таких ошибок разный, он указан рядом с кодом. Ошибки с кодами BITRIX_REST_V3_* приходят со статусом 400.
Ошибки валидации объекта
Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Не заполнено обязательное поле "name" |
Передайте |
|
|
Не заполнено обязательное поле "elements" |
Передайте в каждом разделе |
|
|
Значение поля не содержится в списке допустимых значений: user, department, project, structure-node |
Передайте один из типов участника из описания параметра |
|
|
Значение поля должно быть не меньше, чем 1 |
Передайте положительный идентификатор участника |
Ошибки валидации запроса
Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Обязательное поле |
Передайте |
|
|
В поле |
Передайте |
|
|
Значение поля должно быть не меньше, чем 0 |
Передайте |
|
|
Обязательное поле |
Передайте объект |
|
|
Обязательное поле |
Передайте в |
|
|
В поле |
Передайте |
|
|
В поле |
Передайте идентификатор участника числом |
Ошибка неизвестного поля
Код ошибки: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Неизвестное поле |
Уберите лишний ключ. Запрос принимает |
|
|
Неизвестное поле |
Оставьте в поле раздела только |
Неверная конфигурация вида
Код ошибки: INVALID_LAYOUT_CONFIGURATION, HTTP-статус: 400
|
Поле |
Описание ошибки |
Как исправить |
|
|
Invalid form layout configuration. |
Проверьте |
Неверная аудитория вида
Код ошибки: INVALID_LAYOUT_AUDIENCE, HTTP-статус: 400
|
Поле |
Описание ошибки |
Как исправить |
|
|
Invalid form layout audience. |
Проверьте участников: не больше 1000, у каждого тип из списка и положительный идентификатор |
Неподдерживаемая воронка
Код ошибки: UNSUPPORTED_CONTEXT, HTTP-статус: 400
|
Поле |
Описание ошибки |
Как исправить |
|
|
This form layout context is not supported. |
Проверьте |
Нет доступа
Код ошибки: PERMISSION_DENIED, HTTP-статус: 403
|
Поле |
Описание ошибки |
Как исправить |
|
|
Insufficient permissions to work with this form layout. |
Создавать виды может пользователь с правом изменять общий вид карточки этого типа объекта |
Ошибка сохранения
Код ошибки: STORAGE_FAILED, HTTP-статус: 500
|
Поле |
Описание ошибки |
Как исправить |
|
|
Could not complete the operation on the form layout. |
Повторите запрос позже. Если ошибка повторяется, обратитесь в поддержку |
Метод не найден
Код ошибки: BITRIX_REST_V3_EXCEPTION_METHODNOTFOUNDEXCEPTION, HTTP-статус 404
|
Поле |
Описание ошибки |
Как исправить |
|
|
Метод |
Проверьте имя метода: оно пишется в нижнем регистре, например |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Виды карточки CRM в REST 3.0: обзор методов
- Изменить вид карточки v 3.0 crm.<тип>.detailpagelayout.update
- Получить вид карточки v 3.0 crm.<тип>.detailpagelayout.get
- Получить список дополнительных видов карточки v 3.0 crm.<тип>.detailpagelayout.list
- Удалить дополнительный вид карточки v 3.0 crm.<тип>.detailpagelayout.delete
- Установить текущий вид карточки v 3.0 crm.<тип>.detailpagelayout.setcurrent