Add Comment task.commentitem.add
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: any user with read access permission to the task or higher.
The method task.commentitem.add adds a new comment to a task.
DEPRECATED
The development of this method has been halted since version tasks 25.700.0. Use tasks.task.chat.message.send.
Method Parameters
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 method to get the list of tasks |
|
FIELDS* |
Object with comment fields |
FIELDS Parameter
Required parameters are marked with *
|
Name |
Description |
|
POST_MESSAGE* |
Message text |
|
AUTHOR_ID |
Identifier of the user on whose behalf the comment should be created. You can obtain the user identifier using the user.get method. The method |
|
POST_DATE |
Message date |
|
UF_FORUM_MESSAGE_DOC |
Array with identifiers of files from Drive. Prefix each identifier with The comment author must have access to the attached files; otherwise, the method will return an error. |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"TASKID":8017,"FIELDS":{"POST_MESSAGE":"Text of the new task comment","AUTHOR_ID":503,"POST_DATE":"2025-07-15T14:30:00+02:00","UF_FORUM_MESSAGE_DOC":["n4755","n4753"]}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/task.commentitem.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"TASKID":8017,"FIELDS":{"POST_MESSAGE":"Text of the new task comment","AUTHOR_ID":503,"POST_DATE":"2025-07-15T14:30:00+02:00","UF_FORUM_MESSAGE_DOC":["n4755","n4753"]},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/task.commentitem.add
// 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 (the ID of the newly created comment)
type CommentItemAddResult = number
try {
const response = await $b24.actions.v2.call.make<CommentItemAddResult>({
method: 'task.commentitem.add',
params: {
TASKID: 8017,
FIELDS: {
POST_MESSAGE: 'Text of the new task comment',
AUTHOR_ID: 503,
POST_DATE: '2025-07-15T14:30:00+02:00',
UF_FORUM_MESSAGE_DOC: ['n4755', 'n4753'],
},
},
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('New comment ID:', 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 addTaskComment() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'task.commentitem.add',
params: {
TASKID: 8017,
FIELDS: {
POST_MESSAGE: 'Text of the new task comment',
AUTHOR_ID: 503,
POST_DATE: '2025-07-15T14:30:00+02:00',
UF_FORUM_MESSAGE_DOC: ['n4755', 'n4753'],
},
},
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('New comment ID:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addTaskComment)
</script>
try {
$response = $b24Service
->core
->call(
'task.commentitem.add',
[
'TASKID' => 8017,
'FIELDS' => [
'POST_MESSAGE' => 'Text of the new task comment',
'AUTHOR_ID' => 503,
'POST_DATE' => '2025-07-15T14:30:00+02:00',
'UF_FORUM_MESSAGE_DOC' => ['n4755', 'n4753'],
],
]
);
$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 adding task comment: ' . $e->getMessage();
}
BX24.callMethod(
'task.commentitem.add',
{
"TASKID": 8017,
"FIELDS": {
"POST_MESSAGE": "Text of the new task comment",
"AUTHOR_ID": 503,
"POST_DATE": "2025-07-15T14:30:00+02:00",
"UF_FORUM_MESSAGE_DOC": ["n4755", "n4753"]
}
},
function(result){
console.info(result.data());
console.log(result);
}
);
require_once('crest.php');
$result = CRest::call(
'task.commentitem.add',
[
'TASKID' => 8017,
'FIELDS' => [
'POST_MESSAGE' => 'Text of the new task comment',
'AUTHOR_ID' => 503,
'POST_DATE' => '2025-07-15T14:30:00+02:00',
'UF_FORUM_MESSAGE_DOC' => ['n4755', 'n4753']
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP Status: 200
{
"result": 3141,
"time": {
"start": 1753262861.683775,
"finish": 1753262862.001611,
"duration": 0.31783604621887207,
"processing": 0.27428317070007324,
"date_start": "2025-07-23T12:27:41+02:00",
"date_finish": "2025-07-23T12:27:42+02:00",
"operating_reset_at": 1753263461,
"operating": 0.2742629051208496
}
}
Returned Data
|
Name |
Description |
|
result |
Identifier of the new comment |
|
time |
Information about the request execution time |
Error Handling
HTTP Status: 400
{
"error":"ERROR_CODE",
"error_description":"Insufficient permissions to add a comment.<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 is not specified |
Required parameter |
|
|
Insufficient permissions to add a comment |
No access permission to the task |
|
|
File not found |
The file from the |
|
|
TASKS_ERROR_EXCEPTION_#256; Param #1 (arFields) for method ctaskcommentitem::add() must not contain key |
The field |
|
|
TASKS_ERROR_EXCEPTION_#256; Param #0 (taskId) for method ctaskcommentitem::add() expected to be of type "integer", but given something else.; 256/TE/WRONG_ARGUMENTS |
An incorrect value type for the parameter was specified, for example, for |
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 |