Set a Set of Additional Content Blocks in the CRM Timeline Record: crm.timeline.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.timeline.layout.blocks.set sets a set of additional content blocks for a timeline record.
Setting a new set of additional content blocks in a timeline record will overwrite any previously added set within the same application.
The setting of additional content blocks cannot be applied to timeline records related to:
- deals; for deals, use the methods crm.activity.layout.blocks.*,
- timeline log records,
- deprecated timeline records.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
entityTypeId* |
Identifier of the CRM object to which the timeline record is linked |
|
entityId* |
Identifier of the CRM object to which the timeline record is linked |
|
timelineId* |
Identifier of the timeline record |
|
layout* |
Object describing the set of additional content blocks |
Display Features
If a timeline record contains more than one set of additional content blocks, they are displayed in the order they were added.
In the HTML markup, data attributes indicate which application added the set of additional content blocks:
data-app-name: name of the applicationdata-rest-client-id: identifier of the application
Code Examples
In the timeline record with id = 8, linked to a deal 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,"timelineId":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.timeline.layout.blocks.set
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"entityTypeId":2,"entityId":4,"timelineId":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.timeline.layout.blocks.set
try
{
const response = await $b24.callMethod(
'crm.timeline.layout.blocks.set',
{
entityTypeId: 2, // Deal
entityId: 4, // Deal ID
timelineId: 8, // ID of the timeline record linked to this deal
layout: layout, // Object describing the set of additional content blocks
}
);
const result = response.getData().result;
console.info(result);
}
catch( error )
{
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'crm.timeline.layout.blocks.set',
[
'entityTypeId' => 2, // Deal
'entityId' => 4, // Deal ID
'timelineId' => 8, // ID of the timeline record 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 timeline 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.timeline.layout.blocks.set',
{
entityTypeId: 2, // Deal
entityId: 4, // Deal ID
timelineId: 8, // ID of the timeline record 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.timeline.layout.blocks.set',
[
'entityTypeId' => 2,
'entityId' => 4,
'timelineId' => 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 '';
Response Handling
HTTP Status: 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
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response. On successful execution, contains an object with the field |
|
time |
Information about the execution time of the request |
Result Object
|
Name |
Description |
|
success |
Result of setting the set of additional content blocks. The field is returned on successful execution of the method and has the value |
Error Handling
HTTP Status: 400
{
"error": "ERROR_WRONG_CONTEXT",
"error_description": "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 |
|
|
Method call is only possible in the context of a REST application |
|
|
The element to which the timeline record is linked was not found |
|
|
Timeline record not found |
|
|
Access denied |
|
|
The type of timeline record is not suitable for adding a set of additional content blocks |
|
|
The |
The method also returns errors related to 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 |
Continue Learning
- Additional Content Blocks for the Timeline: Overview of Methods
- Retrieve a Set of Additional Content Blocks for the Timeline Record crm.timeline.layout.blocks.get
- Delete a Set of Additional Content Blocks for the Timeline Record crm.timeline.layout.blocks.delete
- Example Application with Additional Content Blocks