Update Comment task.commentitem.update

Scope: task

Who can execute the method: administrator

The method task.commentitem.update updates a comment.

Method development has been halted since version tasks 25.700.0

The method task.commentitem.update does not work in the new task card, use the method im.message.update to work with task chat.

Method Parameters

Pass parameters in the request according to the order in the table. If the order is violated, the request will return an error.

Required parameters are marked with *

Name `type`	Description
TASKID* `integer`	Task identifier. The task identifier can be obtained when creating a new task or by using the method to get the list of tasks
ITEMID* `integer`	Comment identifier. The comment identifier can be obtained when adding a new comment or by using the method to get the list of comments
FIELDS* `object`	Object with comment fields

FIELDS Parameter

Required parameters are marked with *

Name
type

Description

POST_MESSAGE*
string

Message text

UF_FORUM_MESSAGE_DOC
array

Array with file identifiers from Drive. Prefix each identifier with n, for example, ['n123', 'n456', ... ].

The author of the comment must have access to the attached files; otherwise, the method will return an error.

The field is completely overwritten. To add a file to already uploaded ones, pass the identifiers of all files in the array — both old and new.

Code Examples

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"TASKID":8017,"ITEMID":3167,"FIELDS":{"POST_MESSAGE":"Comment updated","UF_FORUM_MESSAGE_DOC":["n4755"]}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/task.comm

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"TASKID":8017,"ITEMID":3167,"FIELDS":{"POST_MESSAGE":"Comment updated","UF_FORUM_MESSAGE_DOC":["n4755"]},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/task.commentitem.update

try
        {
        	const response = await $b24.callMethod(
        		'task.commentitem.update',
        		{
        			"TASKID": 8017,
        			"ITEMID": 3167,
        			"FIELDS": {
        				"POST_MESSAGE": "Comment updated",
        				"UF_FORUM_MESSAGE_DOC": ["n4755"]
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        	console.log(result);
        }
        catch( error )
        {
        	console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'task.commentitem.update',
                    [
                        'TASKID' => 8017,
                        'ITEMID' => 3167,
                        'FIELDS' => [
                            'POST_MESSAGE'         => 'Comment updated',
                            'UF_FORUM_MESSAGE_DOC' => ['n4755'],
                        ],
                    ]
                );
        
            $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 updating task comment: ' . $e->getMessage();
        }

BX24.callMethod(
            'task.commentitem.update',
            {
                "TASKID": 8017,
                "ITEMID": 3167,
                "FIELDS": {
                    "POST_MESSAGE": "Comment updated",
                    "UF_FORUM_MESSAGE_DOC": ["n4755"]
                }
            },
            function(result){
                console.info(result.data());
                console.log(result);
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'task.commentitem.update',
            [
                'TASKID' => 8017,
                'ITEMID' => 3167,
                'FIELDS' => [
                    'POST_MESSAGE' => 'Comment updated',
                    'UF_FORUM_MESSAGE_DOC' => ['n4755']
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
            "result": true,
            "time": {
                "start": 1753338761.030934,
                "finish": 1753338761.389114,
                "duration": 0.35817980766296387,
                "processing": 0.16595101356506348,
                "date_start": "2025-07-24T09:32:41+02:00",
                "date_finish": "2025-07-24T09:32:41+02:00",
                "operating_reset_at": 1753339361,
                "operating": 0.16593098640441895
            }
        }

Returned Data

Name `type`	Description
result `boolean`	Returns `true` if the comment was successfully updated
time `time`	Information about the request execution time

Error Handling

HTTP status: 400

{
            "error":"ERROR_CODE",
            "error_description":"Comment text not specified.<br>"
        }

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	Value
`ERROR_CORE`	Comment text not specified.	Required parameter `POST_MESSAGE` not provided or empty
`ERROR_CORE`	TASKS_ERROR_EXCEPTION_#4; Action is not allowed; 4/TE/ACTION_NOT_ALLOWED	Error returned in the following cases: Incorrect parameter order specified in the method No access permission to the task Attempting to update another user's comment If the specified task or comment does not exist
`ERROR_CORE`	TASKS_ERROR_EXCEPTION_#256; Param #0 (taskId) for method ctaskcommentitem::delete() expected to be of type "integer", but given something else.; 256/TE/WRONG_ARGUMENTS	Error returned in the following cases: Required parameter not specified, for example, `TASKID` Incorrect value type specified for the parameter, for example, for `TASKID`

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

Add comment

Get comment by id

Update Comment task.commentitem.update

Method ParametersMethod Parameters

FIELDS ParameterFIELDS Parameter

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