Add Comment crm.timeline.comment.add

Scope: crm

Who can execute the method: any user

This method adds a new activity of type "Comment" 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 activity of type "Comment" in the form of a structure:


        fields:
        {
            "ENTITY_ID": 'value',
            "ENTITY_TYPE": 'value',
            "COMMENT": 'value',
            "FILES": [
                [
                    "file name", 
                    "file content"
                ],
                [
                    "file name",
                    "file content"
                ],
            ]
        }

The file content is transmitted as a base64 string

Warning

Starting from crm version 23.100.0, the method only accepts parameters with the key fields in lowercase. Other undocumented variants (Fields, FIELDS, arFields) are not accepted.

Parameter fields

Required parameters are marked with *

Name `type`	Description
ENTITY_ID* `integer`	`ID` of the element to which the comment is attached. The value can be obtained using the method `crm.item.list` or when creating an element with the help of `crm.item.add`
ENTITY_TYPE* `string`	Identifier of the system or user-defined type of the CRM object to which the comment is attached. For example: `lead`, `deal`, `contact`, `company`, `order`, `dynamic_1046`
COMMENT* `string`	The text of the comment
FILES `attached_diskfile`	List of files. An array of values described according to the rules

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":{"ENTITY_ID":10,"ENTITY_TYPE":"deal","COMMENT":"New comment was added","FILES":[["1.gif","R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw=="],["2.gif","R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw=="]]}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.timeline.comment.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"ENTITY_ID":10,"ENTITY_TYPE":"deal","COMMENT":"New comment was added","FILES":[["1.gif","R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw=="],["2.gif","R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw=="]]},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.timeline.comment.add

try
        {
        	const response = await $b24.callMethod(
        		"crm.timeline.comment.add",
        		{
        			fields:
        			{
        				"ENTITY_ID": 10,
        				"ENTITY_TYPE": "deal",
        				"COMMENT": "New comment was added",
        				"FILES": [
        					[
        						"1.gif", 
        						"R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw=="
        					],
        					[
        						"2.gif",
        						"R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw=="
        					],
        				]
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.dir(result);
        }
        catch( error )
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.timeline.comment.add',
                    [
                        'fields' => [
                            'ENTITY_ID'   => 10,
                            'ENTITY_TYPE' => 'deal',
                            'COMMENT'     => 'New comment was added',
                            'FILES'       => [
                                ['1.gif', 'R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw=='],
                                ['2.gif', 'R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw=='],
                            ],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            // Your required data processing logic
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding timeline comment: ' . $e->getMessage();
        }

BX24.callMethod(
            "crm.timeline.comment.add",
            {
                fields:
                {
                    "ENTITY_ID": 10,
                    "ENTITY_TYPE": "deal",
                    "COMMENT": "New comment was added",
                    "FILES": [
                        [
                            "1.gif", 
                            "R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw=="
                        ],
                        [
                            "2.gif",
                            "R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw=="
                        ],
                    ]
                }
            }, result => {
                if (result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.timeline.comment.add',
            [
                'fields' => [
                    'ENTITY_ID' => 10,
                    'ENTITY_TYPE' => 'deal',
                    'COMMENT' => 'New comment was added',
                    'FILES' => [
                        ["1.gif", "R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw=="],
                        ["2.gif", "R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw=="]
                    ]
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

{
            "result": 999,
            "time": {
                "start": 1715091541.642592,
                "finish": 1715091541.730599,
                "duration": 0.08800697326660156,
                "date_start": "2024-05-03T17:19:01+02:00",
                "date_finish": "2024-05-03T17:19:01+02:00",
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `integer`	Returns the integer identifier of the added comment
time `time`	Information about the execution time of the request

Error Handling

HTTP Status: 400

{
            "error": "NOT_FOUND",
            "error_description": "Not found."
        }

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
`OWNER_NOT_FOUND`	Owner of the element not found
`ACCESS_DENIED`	Insufficient permissions
`NOT_FOUND`	Element not found
`INVALID_ARG_VALUE`	Empty comment
`100`	Required fields not provided

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

Overview of Methods

Update Comment

Add Comment crm.timeline.comment.add

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning