Update Comment task.commentitem.update

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: task

Who can execute the method: administrator

The method task.commentitem.update updates comment data.

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
type

Description

TASKID*
integer

Task identifier.

The task identifier can be obtained when creating a new task or by using the get task list method.

ITEMID*
integer

Comment identifier.

The comment identifier can be obtained when adding a new comment or by using the get comment list method.

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 -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.commentitem.update
        
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>';
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "task.commentitem.update", b24.Params{
        	"TASKID": 8017,
        	"ITEMID": 3167,
        	"FIELDS": b24.Params{
        		"POST_MESSAGE":         "Comment updated",
        		"UF_FORUM_MESSAGE_DOC": []string{"n4755"},
        	},
        })
        if err != nil {
        	return fmt.Errorf("task.commentitem.update: %w", err)
        }
        
        var ok bool
        if err := json.Unmarshal(res.Result, &ok); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println("done:", ok)
        

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 consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Code

Description

Value

ERROR_CORE

Comment text not specified.

Required parameter POST_MESSAGE is not provided or is empty.

ERROR_CORE

TASKS_ERROR_EXCEPTION_#4; Action is not allowed; 4/TE/ACTION_NOT_ALLOWED

This error is returned in the following cases:

  • Incorrect parameter order 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

This error is returned in the following cases:

  • Required parameter, such as TASKID, is not specified.
  • Incorrect value type for the parameter, for example, for TASKID.

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
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

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

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

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 — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not 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

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

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 provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

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

Continue Learning