Установить набор дополнительных контентных блоков в дело crm.activity.layout.blocks.set
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
crmКто может выполнять метод: любой пользователь с правом на изменение элемента CRM, к которому привязано дело
Метод crm.activity.layout.blocks.set устанавливает набор дополнительных контентных блоков в дело.
Метод работает только в контексте приложения: при вызове через вебхук он вернет ошибку ERROR_WRONG_CONTEXT. Приложение изменяет только тот набор блоков, который установило само. Повторный вызов заменяет этот набор целиком.
Метод работает только с делами. Чтобы установить набор блоков в комментарий или другую запись таймлайна, используйте crm.timeline.layout.blocks.set.
Набор блоков нельзя установить в конфигурируемое дело и в дело устаревшего типа — такое дело таймлайн выводит не как конфигурируемую запись. В этих случаях метод вернет ошибку UNSUITABLE_ACTIVITY_TYPE_ERROR. Определить пригодность дела заранее по данным REST нельзя, проверить можно только пробным вызовом.
Если дело привязано сразу к нескольким элементам CRM, набор блоков остается один и выводится в таймлайне каждого связанного элемента. Связями управляют методы crm.activity.binding.*.
Порядок вызова методов и общие правила работы с наборами блоков описаны в обзоре раздела.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
entityTypeId* |
Идентификатор типа объекта CRM, к которому привязано дело, например |
|
entityId* |
Идентификатор объекта CRM, к которому привязано дело, например идентификатор сделки |
|
activityId* |
Идентификатор дела. Возвращают методы crm.activity.add и crm.activity.list |
|
layout* |
Объект, описывающий набор дополнительных контентных блоков (подробное описание) |
Параметр layout
|
Название |
Описание |
|
blocks* |
Ассоциативный массив контентных блоков. Ключ — идентификатор блока, значение — описание блока |
Ограничения на blocks:
- поле
blocksобязательно, иначе метод вернет ошибкуFIELD_IS_REQUIRED - в наборе может быть не больше 20 блоков, иначе метод вернет ошибку
TOO_MANY_ITEMS - ключ блока может содержать только латинские буквы, цифры, дефис и знак подчеркивания, иначе метод вернет ошибку
KEY_CONTAIN_WRONG_SYMBOLS - тип блока должен входить в список допустимых типов, иначе метод вернет ошибку
ENUM_FIELD
Каждый блок описывается полями type и properties. Состав properties зависит от типа блока:
|
type |
Что выводит |
Обязательные поля |
|
|
Строку форматированного текста |
|
|
|
Длинный текст, свернутый до превью |
|
|
|
Ссылку с действием по нажатию |
|
|
|
Крайний срок дела, который можно изменить прямо в блоке |
Обязательных полей нет |
|
|
Пару заголовок — значение, где значение — вложенный блок типа |
|
|
|
Несколько блоков типа |
|
Полный список полей каждого типа, включая необязательные, приведен в описании структуры ContentBlockDto.
Особенности отображения
Если разные приложения добавили в дело свои наборы дополнительных контентных блоков, наборы выводятся в порядке добавления.
В HTML-верстке data-атрибуты показывают, каким приложением добавлен набор дополнительных контентных блоков:
data-app-name— название приложенияdata-rest-client-id— идентификатор приложения
Примеры кода
Установить набор из четырех дополнительных контентных блоков в дело с id = 8, привязанное к сделке с id = 4:
- текст
- длинный многострочный текст
- ссылка
- блок с заголовком
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"entityTypeId":2,"entityId":4,"activityId":8,"layout":{"blocks":{"block_1":{"type":"text","properties":{"value":"Здравствуйте!\nМы начинаем.","multiline":true,"bold":true,"color":"base_90"}},"block_2":{"type":"largeText","properties":{"value":"Здравствуйте!\nМы начинаем.\nМы продолжаем.\nМы все еще работаем над этим.\nМы продолжаем.\nМы близки к результату.\nДо свидания."}},"block_3":{"type":"link","properties":{"text":"Открыть сделку","bold":true,"action":{"type":"redirect","uri":"/crm/deal/details/123/"}}},"block_4":{"type":"withTitle","properties":{"title":"Заголовок","block":{"type":"text","properties":{"value":"Какое-то значение"}}}}}},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.activity.layout.blocks.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
// Shape of the payload returned in result (match the "response handling" section of the page)
type SetLayoutBlocksResult = {
success: boolean
}
try {
const response = await $b24.actions.v2.call.make<SetLayoutBlocksResult>({
method: 'crm.activity.layout.blocks.set',
params: {
entityTypeId: 2, // Deal
entityId: 4, // Deal ID
activityId: 8, // Activity ID linked to the deal
layout: {
blocks: {
block_1: {
type: 'text',
properties: {
value: 'Hello!\nWe are starting.',
multiline: true,
bold: true,
color: 'base_90',
},
},
block_2: {
type: 'largeText',
properties: {
value: 'Hello!\nWe are starting.\nWe are continuing.\nWe are still working on this.\nWe are continuing.\nWe are close to the result.\nGoodbye.',
},
},
block_3: {
type: 'link',
properties: {
text: 'Open deal',
bold: true,
action: {
type: 'redirect',
uri: '/crm/deal/details/123/',
},
},
},
block_4: {
type: 'withTitle',
properties: {
title: 'Header',
block: {
type: 'text',
properties: {
value: 'Some value',
},
},
},
},
},
},
},
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('Layout blocks set successfully:', result.success)
}
} 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 setActivityLayoutBlocks() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.activity.layout.blocks.set',
params: {
entityTypeId: 2, // Deal
entityId: 4, // Deal ID
activityId: 8, // Activity ID linked to the deal
layout: {
blocks: {
block_1: {
type: 'text',
properties: {
value: 'Hello!\nWe are starting.',
multiline: true,
bold: true,
color: 'base_90',
},
},
block_2: {
type: 'largeText',
properties: {
value: 'Hello!\nWe are starting.\nWe are continuing.\nWe are still working on this.\nWe are continuing.\nWe are close to the result.\nGoodbye.',
},
},
block_3: {
type: 'link',
properties: {
text: 'Open deal',
bold: true,
action: {
type: 'redirect',
uri: '/crm/deal/details/123/',
},
},
},
block_4: {
type: 'withTitle',
properties: {
title: 'Header',
block: {
type: 'text',
properties: {
value: 'Some value',
},
},
},
},
},
},
},
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('Layout blocks set successfully:', result.success)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', setActivityLayoutBlocks)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.activity.layout.blocks.set(entity_type_id=2, entity_id=4, activity_id=8, layout={
"blocks": {
"block_1": {
"type": "text",
"properties": {
"value": "Здравствуйте!\nМы начинаем.",
"multiline": True,
"bold": True,
"color": "base_90",
},
},
"block_2": {
"type": "largeText",
"properties": {
"value": "Здравствуйте!\nМы начинаем.\nМы продолжаем.\nМы все еще работаем над этим.\nМы продолжаем.\nМы близки к результату.\nДо свидания.",
},
},
"block_3": {
"type": "link",
"properties": {
"text": "Открыть сделку",
"bold": True,
"action": {
"type": "redirect",
"uri": "/crm/deal/details/123/",
},
},
},
"block_4": {
"type": "withTitle",
"properties": {
"title": "Заголовок",
"block": {
"type": "text",
"properties": {
"value": "Какое-то значение",
},
},
},
},
},
}).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print('Ошибка Bitrix API', f'error: {error.error}', f'error_description: {error.error_description}', sep='\n')
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
try {
$response = $b24Service
->core
->call(
'crm.activity.layout.blocks.set',
[
'entityTypeId' => 2, // Сделка
'entityId' => 4, // ID Сделки
'activityId' => 8, // ID Дела привязанного к данной сделке
'layout' => [
'blocks' => [
'block_1' => [
'type' => "text",
'properties' => [
'value' => "Здравствуйте!\nМы начинаем.",
'multiline' => true,
'bold' => true,
'color' => "base_90",
],
],
'block_2' => [
'type' => "largeText",
'properties' => [
'value' => "Здравствуйте!\nМы начинаем.\nМы продолжаем.\nМы все еще работаем над этим.\nМы продолжаем.\nМы близки к результату.\nДо свидания.",
],
],
'block_3' => [
'type' => "link",
'properties' => [
'text' => "Открыть сделку",
'bold' => true,
'action' => [
'type' => "redirect",
'uri' => "/crm/deal/details/123/",
],
],
],
'block_4' => [
'type' => "withTitle",
'properties' => [
'title' => "Заголовок",
'block' => [
'type' => "text",
'properties' => [
'value' => "Какое-то значение",
],
],
],
],
],
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error setting activity layout blocks: ' . $e->getMessage();
}
const layout = {
blocks: {
'block_1': {
type: "text",
properties: {
value: "Здравствуйте!\nМы начинаем.",
multiline: true,
bold: true,
color: "base_90"
}
},
'block_2': {
type: "largeText",
properties: {
value: "Здравствуйте!\nМы начинаем.\nМы продолжаем.\nМы все еще работаем над этим.\nМы продолжаем.\nМы близки к результату.\nДо свидания."
}
},
'block_3': {
type: "link",
properties: {
text: "Открыть сделку",
bold: true,
action: {
type: "redirect",
uri: "/crm/deal/details/123/"
}
}
},
'block_4': {
type: "withTitle",
properties: {
title: "Заголовок",
block: {
type: "text",
properties: {
value: "Какое-то значение"
}
}
}
}
}
};
BX24.callMethod(
'crm.activity.layout.blocks.set',
{
entityTypeId: 2, // Сделка
entityId: 4, // ID Сделки
activityId: 8, // ID Дела привязанного к данной сделке
layout: layout, // Объект, описывающий набор дополнительных контентных блоков
},
(result) => {
if (result.error()) {
console.error(result.error());
} else {
console.info(result.data());
}
},
);
require_once('crest.php');
$result = CRest::call(
'crm.activity.layout.blocks.set',
[
'entityTypeId' => 2,
'entityId' => 4,
'activityId' => 8,
'layout' => [
'blocks' => [
'block_1' => [
'type' => "text",
'properties' => [
'value' => "Здравствуйте!\nМы начинаем.",
'multiline' => true,
'bold' => true,
'color' => "base_90"
]
],
'block_2' => [
'type' => "largeText",
'properties' => [
'value' => "Здравствуйте!\nМы начинаем.\nМы продолжаем.\nМы все еще работаем над этим.\nМы продолжаем.\nМы близки к результату.\nДо свидания."
]
],
'block_3' => [
'type' => "link",
'properties' => [
'text' => "Открыть сделку",
'bold' => true,
'action' => [
'type' => "redirect",
'uri' => "/crm/deal/details/123/"
]
]
],
'block_4' => [
'type' => "withTitle",
'properties' => [
'title' => "Заголовок",
'block' => [
'type' => "text",
'properties' => [
'value' => "Какое-то значение"
]
]
]
]
]
]
]
);
echo '';
print_r($result);
echo '';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.activity.layout.blocks.set", b24.Params{
"entityTypeId": 2,
"entityId": 4,
"activityId": 8,
"layout": b24.Params{
"blocks": b24.Params{
"block_1": b24.Params{
"type": "text",
"properties": b24.Params{
"value": "Здравствуйте!\nМы начинаем.",
"multiline": true,
"bold": true,
"color": "base_90",
},
},
"block_2": b24.Params{
"type": "largeText",
"properties": b24.Params{
"value": "Здравствуйте!\nМы начинаем.\nМы продолжаем.\nМы все еще работаем над этим.\nМы продолжаем.\nМы близки к результату.\nДо свидания.",
},
},
"block_3": b24.Params{
"type": "link",
"properties": b24.Params{
"text": "Открыть сделку",
"bold": true,
"action": b24.Params{
"type": "redirect",
"uri": "/crm/deal/details/123/",
},
},
},
"block_4": b24.Params{
"type": "withTitle",
"properties": b24.Params{
"title": "Заголовок",
"block": b24.Params{
"type": "text",
"properties": b24.Params{
"value": "Какое-то значение",
},
},
},
},
},
},
})
if err != nil {
return fmt.Errorf("crm.activity.layout.blocks.set: %w", err)
}
// Ответ приходит как json.RawMessage — разберите его
// в структуру под форму ответа, показанную ниже на этой странице.
fmt.Printf("%s\n", res.Result)
Обработка ответа
HTTP-статус: 200
{
"result": {
"success": true
},
"time": {
"start": 1753341040.475739,
"finish": 1753341040.582705,
"duration": 0.10696601867675781,
"processing": 0.04708504676818848,
"date_start": "2025-07-24T17:57:20+00:00",
"date_finish": "2025-07-24T17:57:20+00:00",
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа (подробное описание). Если набор блоков установить не удалось, метод возвращает не |
|
time |
Информация о времени выполнения запроса |
Объект result
|
Название |
Описание |
|
success |
Результат установки набора дополнительных контентных блоков. Поле возвращается при успешном выполнении метода и имеет значение |
Метод не возвращает в ответе сам установленный набор блоков. Чтобы прочитать сохраненный набор, вызовите crm.activity.layout.blocks.get.
После вызова из примера выше дело выглядит так:

Обработка ошибок
HTTP-статус: 400
{
"error": "ERROR_WRONG_CONTEXT",
"error_description": "Вызов метода возможен только в контексте rest приложения"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Код |
Описание |
|
|
Вызов метода возможен только в контексте rest приложения. Метод вызван через вебхук |
|
|
Элемент, к которому привязано дело, не найден. Передан неизвестный |
|
|
Дело с указанным |
|
|
У пользователя нет права на изменение элемента CRM, к которому привязано дело |
|
|
Тип дела не подходит для добавления набора дополнительных контентных блоков |
|
|
Не передано обязательное поле структуры: |
|
|
В объекте структуры передано поле, которого нет в его описании |
|
|
В |
|
|
Ключ блока в |
|
|
Значение поля не соответствует ожидаемому типу, например блок передан не объектом |
|
|
Поле |
Текст ошибки уточняет, какое поле и какой объект структуры ее вызвали.
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Дополнительные контентные блоки дела: обзор методов
- Получить набор дополнительных контентных блоков дела crm.activity.layout.blocks.get
- Удалить набор дополнительных контентных блоков из дела crm.activity.layout.blocks.delete
- Контентный блок конфигурируемого дела
- Пример приложения с дополнительными контентными блоками