Delete Task from Scrum Kanban tasks.api.scrum.kanban.deleteTask
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 removes a task from the Scrum kanban. The task will remain in the sprint on the planning page. The method will not move the task to the backlog.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
sprintId* |
Sprint identifier. You can obtain the identifier using the tasks.api.scrum.sprint.list method |
|
taskId* |
Task identifier. You can obtain the identifier using the tasks.task.list method |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"sprintId":5,"taskId":751}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/tasks.api.scrum.kanban.deleteTask
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"sprintId":5,"taskId":751,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/tasks.api.scrum.kanban.deleteTask
try
{
const response = await $b24.callMethod(
'tasks.api.scrum.kanban.deleteTask',
{
"sprintId": 5,
"taskId": 751,
}
);
const result = response.getData().result;
console.info(result);
}
catch( error )
{
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'tasks.api.scrum.kanban.deleteTask',
[
"sprintId" => 5,
"taskId" => 751,
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
} else {
echo 'Info: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error deleting task: ' . $e->getMessage();
}
BX24.callMethod(
'tasks.api.scrum.kanban.deleteTask',
{
"sprintId": 5,
"taskId": 751,
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'tasks.api.scrum.kanban.deleteTask',
[
'sprintId' => 5,
'taskId' => 751,
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP status: 200
{
"result": true,
"time": {
"start": 1712137817.343984,
"finish": 1712137817.605804,
"duration": 0.26182007789611816,
"processing": 0.018325090408325195,
"date_start": "2024-04-03T12:50:17+02:00",
"date_finish": "2024-04-03T12:50:17+02:00"
}
}
Error Handling
HTTP status: 400
{
"error": 0,
"error_description": "Access denied"
}
|
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 |
|
|
|
Required field |
|
|
|
Required field |
|
|
|
An unknown sprint identifier was provided |
|
|
|
An unknown task identifier was provided or the task does not belong to the sprint group |
|
|
|
Access is denied |
|
|
Unknown error |
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 |
Continue Learning
- Kanban in Scrum: Overview of Methods
- Create a Scrum Kanban Stage tasks.api.scrum.kanban.addStage
- Update Scrum Kanban Stage tasks.api.scrum.kanban.updateStage
- Add Task to Scrum Kanban tasks.api.scrum.kanban.addTask
- Delete Stage tasks.api.scrum.kanban.deleteStage
- Get a list of available fields for the kanban stage tasks.api.scrum.kanban.getFields
- Get Kanban Stages by Sprint ID tasks.api.scrum.kanban.getStages