Add task to favorites list

Add task to favorites list

Function AddTaskToFavorites(Val URL, Val TaskID, Val Token = "") Export

Parameter	CLI option	Type	Required	Description
URL	--url	String	✔	URL of webhook or a Bitrix24 domain, when token used
TaskID	--task	Number, String	✔	Task ID
Token	--token	String	✖	Access token, when app auth method used

Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API

tip

Method at API documentation: tasks.task.favorite.add

1C:Enterprise/OneScript code example

    URL    = "https://b24-ar17wx.bitrix24.by/rest/1/h0m...";
    TaskID = "8618";

    Result = OPI_Bitrix24.AddTaskToFavorites(URL, TaskID);

    URL    = "b24-ar17wx.bitrix24.by";
    Token  = "53100369006e9f06006b12e400000001000...";
    TaskID = "8620";

    Result = OPI_Bitrix24.AddTaskToFavorites(URL, TaskID, Token);

Bash

    oint bitrix24 AddTaskToFavorites \
     --url "b24-ar17wx.bitrix24.by" \
     --task "8670" \
     --token "***"

CMD/Bat

    oint bitrix24 AddTaskToFavorites ^
     --url "b24-ar17wx.bitrix24.by" ^
     --task "8670" ^
     --token "***"

Result

{
 "result": true,
 "time": {
  "start": 1761911567,
  "finish": 1761911567.79857,
  "duration": 0.798569917678833,
  "processing": 0,
  "date_start": "2025-10-31T11:52:47+00:00",
  "date_finish": "2025-10-31T11:52:47+00:00",
  "operating_reset_at": 1761912167,
  "operating": 0
 }
}