Set a set of additional content blocks in the activity crm.activity.layout.blocks.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: administrator
The method crm.activity.layout.blocks.set sets a set of additional content blocks for the activity.
Setting a new set of additional content blocks in the activity will overwrite the previously added set within the same application.
Setting a set of additional content blocks cannot be applied to:
- configurable activity,
- a activity whose type is deprecated.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
entityTypeId* |
Identifier of the CRM object type to which the activity is linked |
|
entityId* |
Identifier of the CRM object to which the activity is linked |
|
activityId* |
Identifier of the activity |
|
layout* |
Object describing the set of additional content blocks |
Code Examples
For the activity with id = 8, linked to the activity with id = 4, we will set the following set of additional content blocks:
- Text
- Long multiline text
- Link
- Block with a title
How to Use Examples in Documentation
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":"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":"Title","block":{"type":"text","properties":{"value":"Some value"}}}}}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.activity.layout.blocks.set
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":"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":"Title","block":{"type":"text","properties":{"value":"Some 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>
try {
$response = $b24Service
->core
->call(
'crm.activity.layout.blocks.set',
[
'entityTypeId' => 2, // Deal
'entityId' => 4, // Deal ID
'activityId' => 8, // ID of the deal linked to this 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' => "Title",
'block' => [
'type' => "text",
'properties' => [
'value' => "Some 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: "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: "Title",
block: {
type: "text",
properties: {
value: "Some value"
}
}
}
}
}
};
BX24.callMethod(
'crm.activity.layout.blocks.set',
{
entityTypeId: 2, // Deal
entityId: 4, // Deal ID
activityId: 8, // ID of the activity linked to this deal
layout: layout, // Object describing the set of additional content blocks
},
(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' => "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' => "Title",
'block' => [
'type' => "text",
'properties' => [
'value' => "Some value"
]
]
]
]
]
]
]
);
echo '';
print_r($result);
echo '';
Example
from b24pysdk.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
client: BaseClient
try:
bitrix_response = client.crm.activity.layout.blocks.set(
entity_type_id=2,
entity_id=101,
activity_id=999,
layout={
"blocks": {
"summary": {
"type": "text",
"properties": {
"value": "Proposal is ready",
"multiline": True,
"bold": True,
"color": "base_90",
},
},
"dealLink": {
"type": "link",
"properties": {
"text": "Open deal",
"bold": True,
"action": {"type": "redirect", "uri": "/crm/deal/details/101/"},
},
},
},
},
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Bitrix API error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
Appearance
If the activity contains more than one set of additional content blocks, they will be displayed in the order they were added.
In the HTML layout, it is explicitly highlighted with data attributes which application added the set of additional content blocks:
data-app-name: name of the application,data-rest-client-id: identifier of the application.
Response Handling
HTTP status: 200
Returns { success: true } in case of successful writing of the set of additional content blocks, otherwise null.
{
"success": true
}
Error Handling
HTTP status: 400
{
"error": "ERROR_WRONG_CONTEXT",
"error_description": "The method call is only possible in the context of a REST application"
}
|
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 |
|
|
The method can only be called in the context of a REST application |
|
|
The element to which the activity is linked was not found |
|
|
The activity was not found |
|
|
Access denied |
|
|
The type of this activity is not suitable for adding a set of additional content blocks |
|
|
The |
The method also returns errors related to the incorrect structure of the set of content blocks. Details can be found in the error message.
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 |