Add Log Entry crm.timeline.logmessage.add
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: 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>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
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}")
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());
}
);
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>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "crm.timeline.logmessage.add", b24.Params{
"fields": b24.Params{
"entityTypeId": 1,
"entityId": 1,
"title": "Test title",
"text": "Test text message",
"iconCode": "info",
},
})
if err != nil {
return fmt.Errorf("crm.timeline.logmessage.add: %w", err)
}
// The method wraps the response in an object with the "logMessage" key.
raw, ok := b24.Unwrap(res.Result, "logMessage")
if !ok {
return fmt.Errorf("no logMessage key in the response")
}
var item struct {
ID b24.ID `json:"id"`
Created string `json:"created"`
AuthorID b24.ID `json:"authorId"`
Title string `json:"title"`
Text string `json:"text"`
IconCode string `json:"iconCode"`
}
if err := json.Unmarshal(raw, &item); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.ID, item.Created)
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 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 |
|
|
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: 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 |