Update Comment task.commentitem.update
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:
taskWho can execute the method: administrator
The method task.commentitem.update updates a comment.
DEPRECATED
The development of this method 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 for working with task chats.
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 |
Description |
|
TASKID* |
Task identifier. The task identifier can be obtained when creating a new task or by using the get task list method. |
|
ITEMID* |
Comment identifier. The comment identifier can be obtained when adding a new comment or by using the get comment list method. |
|
FIELDS* |
Object with comment fields |
FIELDS Parameter
Required parameters are marked with *
|
Name |
Description |
|
POST_MESSAGE* |
Message text |
|
UF_FORUM_MESSAGE_DOC |
Array with file identifiers from Drive. Prefix each identifier with 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 -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
// 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 } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type UpdateCommentResult = boolean
try {
const response = await $b24.actions.v2.call.make<UpdateCommentResult>({
method: 'task.commentitem.update',
params: {
TASKID: 8017,
ITEMID: 3167,
FIELDS: {
POST_MESSAGE: 'Comment updated',
UF_FORUM_MESSAGE_DOC: ['n4755'],
},
},
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('Comment updated successfully:', result)
}
} 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 updateTaskComment() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'task.commentitem.update',
params: {
TASKID: 8017,
ITEMID: 3167,
FIELDS: {
POST_MESSAGE: 'Comment updated',
UF_FORUM_MESSAGE_DOC: ['n4755'],
},
},
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('Comment updated successfully:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', updateTaskComment)
</script>
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 logic for processing data
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 |
Description |
|
result |
Returns |
|
time |
Information about the request execution time. |
Error Handling
HTTP Status: 400
{
"error":"ERROR_CODE",
"error_description":"Comment text not specified.<br>"
}
|
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 |
Value |
|
|
Comment text not specified. |
Required parameter |
|
|
TASKS_ERROR_EXCEPTION_#4; Action is not allowed; 4/TE/ACTION_NOT_ALLOWED |
This error is returned in the following cases:
|
|
|
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 |
This error is returned in the following cases:
|
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 |