Удалить спринт tasks.api.scrum.sprint.delete

Если вы разрабатываете интеграции для Битрикс24 с помощью AI-инструментов (Codex, Claude Code, Cursor), подключите MCP-сервер, чтобы ассистент использовал официальную REST-документацию.

Scope: task

Кто может выполнять метод: любой пользователь, имеющий доступ к Скраму

Метод tasks.api.scrum.sprint.delete удаляет спринт.

При удалении спринта с задачами задачи будут перемещены в бэклог.

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

Обязательные параметры отмечены *

Название
тип

Описание

id*
integer

Идентификатор спринта

Примеры кода

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

curl -X POST \
        -H "Content-Type: application/json" \
        -d '{
        "id": 1
        }' \
        https://your-domain.bitrix24.com/rest/_USER_ID_/_CODE_/tasks.api.scrum.sprint.delete
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Authorization: YOUR_ACCESS_TOKEN" \
        -d '{
        "id": 1
        }' \
        https://your-domain.bitrix24.com/rest/tasks.api.scrum.sprint.delete
        
try
        {
        	const response = await $b24.callMethod(
        		'tasks.api.scrum.sprint.delete',
        		{
        			id: sprintId
        		}
        	);
        	
        	const result = response.getData().result;
        	console.log(result);
        }
        catch( error )
        {
        	console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'tasks.api.scrum.sprint.delete',
                    [
                        'id' => $sprintId
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error deleting sprint: ' . $e->getMessage();
        }
        
const sprintId = 1;
        BX24.callMethod(
            'tasks.api.scrum.sprint.delete',
            {
                id: sprintId
            },
            function(res)
            {
                console.log(res);
            }
        );
        
require_once('crest.php'); // подключение CRest PHP SDK
        
        // выполнение запроса к REST API
        $result = CRest::call(
            'tasks.api.scrum.sprint.delete',
            [
                'id' => 1,
            ]
        );
        
        // Обработка ответа от Битрикс24
        if (isset($result['error'])) {
            echo 'Error: '.$result['error_description'];
        } else {
            print_r($result['result']);
        }
        

Обработка ответа

HTTP-статус: 200

{
            "result" : []
        }
        

При успешном удалении метод возвращает пустой массив.

Обработка ошибок

HTTP-статус: 400

{
            "error": 0,
            "error_description": "Sprint not found"
        }
        

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код

Cообщение об ошибке

Описание

0

Access denied

Нет доступа к Скраму

0

Sprint not found

Такого спринта не существует

0

It is forbidden remove a sprint with items

Нельзя удалить спринт, в котором есть задачи

0

Sprint items have not been moved to backlog

Не удалось переместить задачи из спринта в бэклог

100

Could not find value for parameter {id}

Неверно указано имя параметра или не задан параметр

100

Invalid value {stringValue} to match with parameter {id}. Should be value of type int

Неверный тип параметра

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

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

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение