Add Log Entry crm.timeline.logmessage.add

Scope: crm

Who can execute the method: user with permission to modify the CRM entity 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 `type`	Description
fields* `object`	Field values (detailed description provided below) for adding a new log entry in the form of a structure: `fields: { entityTypeId: "value", entityId: "value", title: "value", text: "value", iconCode: "value", },`

Parameter fields

Required parameters are marked with *

Name `type`	Description
entityTypeId* `integer`	Identifier of the entity type in which the entry will be created
entityId* `integer`	Identifier of the entity item in which the entry will be created
title* `string`	Title of the entry
text* `string`	Text of the entry
iconCode* `string`	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 (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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

try
        {
        	const response = await $b24.callMethod(
        		'crm.timeline.logmessage.add',
        		{
        			fields: {
        				entityTypeId: 1,
        				entityId: 1,
        				title: 'Test title',
        				text: 'Test text message',
        				iconCode: 'info',
        			},
        		}
        	);
        	
        	const result = response.getData().result;
        	if (result.error())
        		console.error(result.error());
        	else
        		console.dir(result);
        }
        catch( error )
        {
        	console.error('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>';

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
type

Description

result
object

Root element of the response.

The result field contains the logMessage object

time
time

Information about the request execution time

logMessage Object

Name `type`	Description
id `integer`	Identifier of the timeline entry
created `datetime`	Date and time of creation
authorId `integer`	User who created the entry
title `string`	Title of the entry
text `string`	Content of the entry
iconCode `string`	Icon code

Error Handling

HTTP status: 400

{
            "error": "ACCESS_DENIED",
            "error_description": "Access denied"
        }

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `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`	Access denied
`OWNER_NOT_FOUND`	The CRM entity with the specified `entityTypeId` and `entityId` does not exist
`100`	Required fields not provided
`0`	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 Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Log Record Journal

Get Log Entry Information

Add Log Entry crm.timeline.logmessage.add

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

logMessage ObjectlogMessage Object

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning