Add Task to Favorites task.item.addtofavorite
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
This method adds a task to Favorites.
DEPRECATED
Development of this method has been halted. Please use tasks.task.favorite.add.
Method Parameters
|
Name |
Description |
|
auth |
Authorization token |
|
TASK_ID |
Task identifier |
|
PARAMS |
This parameter contains the key |
It is mandatory to maintain the order of parameters in the request. If this order is violated, the request will be executed with errors.
Code Examples
How to Use Examples in Documentation
cURL (Webhook)
cURL (OAuth)
JS
PHP
BX24.js
PHP CRest
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"TASK_ID":10,"PARAMS":{"AFFECT_CHILDREN":"Y"}}' \
https://your-domain.com/rest/**put_your_user_id_here**/**put_your_webhook_here**/task.item.addtofavorite
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"TASK_ID":10,"PARAMS":{"AFFECT_CHILDREN":"Y"},"auth":"mqa17fnd5cth4rpwtizyl49tbnzp7omf"}' \
https://your-domain.com/rest/task.item.addtofavorite
try
{
const response = await $b24.callMethod(
"task.item.addtofavorite",
{
TASK_ID: 10,
PARAMS: {
AFFECT_CHILDREN: "Y"
}
}
);
const result = response.getData().result;
console.log(result);
}
catch( error )
{
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'task.item.addtofavorite',
[
'TASK_ID' => 10,
'PARAMS' => [
'AFFECT_CHILDREN' => 'Y',
],
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error adding task to favorites: ' . $e->getMessage();
}
BX24.callMethod(
"task.item.addtofavorite",
{
TASK_ID: 10,
PARAMS: {
AFFECT_CHILDREN: "Y"
}
},
function(result) {
if(result.error())
console.error(result.error());
else
console.log(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'task.item.addtofavorite',
[
'TASK_ID' => 10,
'PARAMS' => [
'AFFECT_CHILDREN' => 'Y'
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Copied