Add Log Entry crm.timeline.logmessage.add
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: a user with permission to edit the CRM object to which the entry will be added
This method adds a new log entry to the timeline.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
fields* |
Field values (detailed description provided below) for adding a new log entry in the form of a structure:
|
Parameter fields
Required parameters are marked with *
|
Name |
Description |
|
entityTypeId* |
Identifier of the entity type in which the entry will be created |
|
entityId* |
Identifier of the entity item in which the entry will be created |
|
title* |
Title of the record |
|
text* |
Text of the entry |
|
iconCode* |
Icon code. A list of available codes can be obtained using the method crm.timeline.icon.list |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"entityTypeId":1,"entityId":1,"title":"Test title","text":"Test text message","iconCode":"info"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.timeline.logmessage.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"entityTypeId":1,"entityId":1,"title":"Test title","text":"Test text message","iconCode":"info"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.timeline.logmessage.add
// 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, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type LogMessageAddResult = {
logMessage: {
id: number,
created: ISODate,
authorId: number,
title: string,
text: string,
iconCode: string,
},
}
try {
const response = await $b24.actions.v2.call.make<LogMessageAddResult>({
method: 'crm.timeline.logmessage.add',
params: {
fields: {
entityTypeId: 1,
entityId: 1,
title: 'Test title',
text: 'Test text message',
iconCode: 'info',
},
},
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.logMessage.id, result.logMessage.title)
}
} 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 addLogMessage() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.timeline.logmessage.add',
params: {
fields: {
entityTypeId: 1,
entityId: 1,
title: 'Test title',
text: 'Test text message',
iconCode: 'info',
},
},
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.logMessage.id, result.logMessage.title)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addLogMessage)
</script>
try {
$response = $b24Service
->core
->call(
'crm.timeline.logmessage.add',
[
'fields' => [
'entityTypeId' => 1,
'entityId' => 1,
'title' => 'Test title',
'text' => 'Test text message',
'iconCode' => 'info',
],
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error adding log message: ' . $e->getMessage();
}
BX24.callMethod(
"crm.timeline.logmessage.add",
{
fields: {
entityTypeId: 1,
entityId: 1,
title: "Test title",
text: "Test text message",
iconCode: "info",
},
},
result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
Example
from b24pysdk.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
client: BaseClient
try:
bitrix_response = client.crm.timeline.logmessage.add(
fields={
"entityTypeId": 1,
"entityId": 1,
"title": "Test title",
"text": "Test text message",
"iconCode": "info"
},
)
result = bitrix_response.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}")
require_once('crest.php');
$result = CRest::call(
'crm.timeline.logmessage.add',
[
'fields' => [
'entityTypeId' => 1,
'entityId' => 1,
'title' => 'Test title',
'text' => 'Test text message',
'iconCode' => 'info',
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP status: 200
{
"result": {
"logMessage": {
"id": 1,
"created": "2024-04-03T10:26:32+02:00",
"authorId": 1,
"title": "Test title",
"text": "Test note",
"iconCode": "info"
}
},
"time": {
"start": 1712132792.910734,
"finish": 1712132793.530359,
"duration": 0.6196250915527344,
"processing": 0.032338857650756836,
"date_start": "2024-04-03T10:26:32+02:00",
"date_finish": "2024-04-03T10:26:33+02:00",
"operating_reset_at": 1705765533,
"operating": 3.3076241016387939
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response. The |
|
time |
Information about the request execution time |
logMessage Object
|
Name |
Description |
|
id |
Identifier of the timeline record |
|
created |
Date and time of creation |
|
authorId |
User who created the entry |
|
title |
Title of the record |
|
text |
Content of the entry |
|
iconCode |
Icon code |
Error Handling
HTTP status: 400
{
"error": "ACCESS_DENIED",
"error_description": "Access denied"
}
|
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 |
|
|
Access denied |
|
|
The CRM object with the specified |
|
|
Required fields are not provided |
|
|
Other errors (e.g., fatal) |
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 |