Удалить задачу из Избранного task.item.deletefromfavorite

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: task

Кто может выполнять метод: любой пользователь

Метод task.item.deletefromfavorite удаляет задачу из Избранного.

DEPRECATED

Развитие метода остановлено. Используйте tasks.task.favorite.remove.

Параметры метода

Название

Описание

auth

Токен авторизации

TASK_ID

Идентификатор задачи

PARAMS

Параметр содержит ключ AFFECT_CHILDREN. Он указывает, добавлять ли в Избранное подзадачи данной задачи

Соблюдение порядка следования параметров в запросе обязательно. При его нарушении запрос будет выполнен с ошибками.

Примеры кода

Как использовать примеры в документации

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"TASK_ID":10,"PARAMS":{"AFFECT_CHILDREN":"Y"}}' \
        https://your-domain.ru/rest/**put_your_user_id_here**/**put_your_webhook_here**/task.item.deletefromfavorite
        
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.ru/rest/task.item.deletefromfavorite
        
// 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
        
        // TODO: verify API version
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type DeleteFromFavoriteResult = boolean
        
        try {
          const response = await $b24.actions.v2.call.make<DeleteFromFavoriteResult>({
            method: 'task.item.deletefromfavorite',
            params: {
              TASK_ID: 10,
              PARAMS: {
                AFFECT_CHILDREN: 'Y',
              },
            },
            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('Task removed from favorites:', 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 deleteFromFavorite() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'task.item.deletefromfavorite',
                params: {
                  TASK_ID: 10,
                  PARAMS: {
                    AFFECT_CHILDREN: 'Y',
                  },
                },
                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('Task removed from favorites:', result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', deleteFromFavorite)
        </script>
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'task.item.deletefromfavorite',
                    [
                        '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 deleting task from favorites: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'task.item.deletefromfavorite',
            {
                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.deletefromfavorite',
            [
                'TASK_ID' => 10,
                'PARAMS' => [
                    'AFFECT_CHILDREN' => 'Y'
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        
// client и ctx уже созданы — см. раздел «SDK для Go»
        res, err := client.Core().Call(ctx, "task.item.deletefromfavorite", b24.Params{
        	"TASK_ID": 10,
        	"PARAMS": b24.Params{
        		"AFFECT_CHILDREN": "Y",
        	},
        })
        if err != nil {
        	return fmt.Errorf("task.item.deletefromfavorite: %w", err)
        }
        
        // Ответ приходит как json.RawMessage — разберите его
        // в структуру под форму ответа, показанную ниже на этой странице.
        fmt.Printf("%s\n", res.Result)