Для AI-агентов: markdown этой страницы — /docs-content/entities/crm-card-layouts.md индекс документации — /llms.txt
Методы в процессе раскатки — появились в обновлении
crm 26.1700.0. Облачная доступность зависит от включения возможности Битрикс24. Пока она не открыта для портала, API отвечает422 METHOD_NOT_YET_AVAILABLEсerror.release.
Именованные раскладки карточки CRM
Храните несколько наборов разделов и полей карточки и выбирайте текущую раскладку для сотрудника.
Битрикс24 API: crm.<entity>.detailpagelayout.*
Скоуп: crm
Операции
- Создать раскладку карточки CRM —
POST /v1/crm/card-layouts/:entityType - Список раскладок карточки CRM —
GET /v1/crm/card-layouts/:entityType - Получить раскладку карточки CRM —
GET /v1/crm/card-layouts/:entityType/:layoutId - Изменить раскладку карточки CRM —
PATCH /v1/crm/card-layouts/:entityType/:layoutId - Удалить раскладку карточки CRM —
DELETE /v1/crm/card-layouts/:entityType/:layoutId - Выбрать текущую раскладку CRM —
PUT /v1/crm/card-layouts/:entityType/current - Получить ID общей раскладки CRM —
GET /v1/crm/card-layouts/:entityType/common-id - Получить ID личной раскладки CRM —
GET /v1/crm/card-layouts/:entityType/personal-id
Ключевые поля
| Поле | Описание |
|---|---|
Полеid |
ОписаниеНепрозрачная строка, включая системные ID. Источник — список раскладок, ID общей раскладки или ID личной раскладки. |
Полеname |
ОписаниеНазвание. У системных раскладок может быть null. |
Полеconfiguration |
ОписаниеРазделы с названиями и массивами элементов. |
Полеaudience |
ОписаниеСотрудники и группы доступа {type,id}. Может быть null. ID сотрудника — из списка сотрудников. |
Что нужно знать перед работой
entityType:company,contact,deal,lead,quote,smartinvoice,smartprocess<N>. Номер смарт-процесса — из списка смарт-процессов.- Категория обязательна во всех запросах. Источник —
GET /v1/categories,0допустим. - Создание возвращает числовой ID. Для последующих запросов преобразуйте его в строку.
- Права на аудиторию, сотрудника и системную раскладку проверяет Битрикс24. Для записи нужен
READWRITE. - Текущая конфигурация карточки — отдельный раздел Раскладка карточки CRM.
Типичный сценарий
- Список раскладок карточки CRM.
- Создать раскладку карточки CRM.
- Изменить раскладку карточки CRM.
- Выбрать текущую раскладку CRM.
- Удалить раскладку карточки CRM.
Лимиты
Список читает одну страницу с limit и offset. Общего количества и hasMore нет. Допустимые значения и ограничения полей проверяет Битрикс24. Пустые массивы могут быть отклонены как отсутствующие поля. Изменение переданного массива заменяет его целиком.