Delete a Kanban or "My Planner" Stage task.stages.delete
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
taskWho can execute the method:
- any user for stages of their own "My Planner"
- the group owner or moderator for the group's Kanban stages
The method task.stages.delete deletes a Kanban or "My Planner" stage.
Only an empty stage without a system type can be deleted. First move the tasks out of the stage with the task.stages.movetask method.
The system type of a stage is returned by the task.stages.get method in the SYSTEM_TYPE field. The first stage always has NEW. To delete the first stage, first move it with the task.stages.update method using the AFTER_ID parameter in fields. The NEW type passes to the stage that becomes the first one.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
id* |
Identifier of the stage to be deleted |
|
isAdmin |
If |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"id": 5
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/task.stages.delete
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"id": 5,
"auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/task.stages.delete
// 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
try {
const response = await $b24.actions.v2.call.make<boolean>({
method: 'task.stages.delete',
params: {
id: 5,
},
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('Stage deleted:', 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 deleteStage() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'task.stages.delete',
params: {
id: 5,
},
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('Stage deleted:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', deleteStage)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.task.stages.delete(
bitrix_id=5,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Bitrix API error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
try {
$stageId = 5;
$response = $b24Service
->core
->call(
'task.stages.delete',
[
'id' => $stageId,
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// Your logic for processing data
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error deleting task stage: ' . $e->getMessage();
}
const stageId = 5;
BX24.callMethod(
'task.stages.delete',
{
id: stageId,
},
function(res)
{
console.log(res);
}
);
require_once('crest.php'); // include CRest PHP SDK
$stageId = 5;
// execute request to REST API
$result = CRest::call(
'task.stages.delete',
[
'id' => $stageId
]
);
// Process response from Bitrix24
if ($result['error']) {
echo 'Error: '.$result['error_description'];
} else {
print_r($result['result']);
}
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "task.stages.delete", b24.Params{
"id": 5,
})
if err != nil {
return fmt.Errorf("task.stages.delete: %w", err)
}
var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println("done:", ok)
Response Handling
HTTP Status: 200
{
"result": true,
"time": {
"start": 1793956087,
"finish": 1793956087.677343,
"duration": 0.6773428916931152,
"processing": 0,
"date_start": "2026-11-06T12:08:07+03:00",
"date_finish": "2026-11-06T12:08:07+03:00"
}
}
Returned Data
|
Name |
Description |
|
result |
Returns |
|
time |
Information about the request execution time |
Error Handling
HTTP Status: 400
{
"error": "NO_EMPTY",
"error_description": "There are tasks in this stage"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Status |
Code |
Description |
Value |
|
|
|
Stage was not found |
There is no stage with the ID |
|
|
|
Default stage cannot be deleted |
The stage is a system stage, for example the first stage of a Kanban or "My Planner" |
|
|
|
You cannot manage stages |
The user is not the owner or moderator of the group the stage belongs to, or the stage belongs to another user's "My Planner" |
|
|
|
There are tasks in this stage |
The stage contains tasks |
|
|
|
Argument "id" is required, but no value passed for task.stages.delete |
The required parameter |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it 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
- Stages of Kanban and "My Planner": Overview of Methods
- Add a Kanban or "My Planner" Stage task.stages.add
- Update Kanban Stage or "My Planner" task.stages.update
- Get the List of Kanban Stages or "My Planner" task.stages.get
- Check the Ability to Move Task task.stages.canmovetask
- Move Task from One Stage to Another task.stages.movetask