Set a Set of Additional Content Blocks in the CRM Timeline Record: crm.timeline.layout.blocks.set
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
crmWho can execute the method: any user with permission to modify the CRM entity to which the record is linked
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
// 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 TimelineLayoutBlocksSetResult = {
success: boolean
}
try {
const response = await $b24.actions.v2.call.make<TimelineLayoutBlocksSetResult>({
method: 'crm.timeline.layout.blocks.set',
params: {
entityTypeId: 2, // Deal
entityId: 4, // Deal ID
timelineId: 8, // Timeline entry ID 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',
},
},
},
},
},
},
},
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(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 setTimelineLayoutBlocks() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.timeline.layout.blocks.set',
params: {
entityTypeId: 2, // Deal
entityId: 4, // Deal ID
timelineId: 8, // Timeline entry ID 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',
},
},
},
},
},
},
},
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(result.success)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', setTimelineLayoutBlocks)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
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 it.\nWe are continuing.\nWe are close to the result.\nGoodbye.",
},
},
"block_3": {
"type": "link",
"properties": {
"text": "Open the 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",
},
},
},
},
},
}
try:
bitrix_response = client.crm.timeline.layout.blocks.set(
entity_type_id=2,
entity_id=4,
timeline_id=8,
layout=layout,
).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}")
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 '';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "crm.timeline.layout.blocks.set", b24.Params{
"entityTypeId": 2,
"entityId": 4,
"timelineId": 8,
"layout": b24.Params{
"blocks": b24.Params{
"block_1": b24.Params{
"type": "text",
"properties": b24.Params{
"value": "Hello!\nWe are starting.",
"multiline": true,
"bold": true,
"color": "base_90",
},
},
"block_2": b24.Params{
"type": "largeText",
"properties": b24.Params{
"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": b24.Params{
"type": "link",
"properties": b24.Params{
"text": "Open Deal",
"bold": true,
"action": b24.Params{
"type": "redirect",
"uri": "/crm/deal/details/123/",
},
},
},
"block_4": b24.Params{
"type": "withTitle",
"properties": b24.Params{
"title": "Title",
"block": b24.Params{
"type": "text",
"properties": b24.Params{
"value": "Some value",
},
},
},
},
},
},
})
if err != nil {
return fmt.Errorf("crm.timeline.layout.blocks.set: %w", err)
}
var item struct {
Success bool `json:"success"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.Success)
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 consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
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: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it 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