Add a Kanban or "My Plan" Stage task.stages.add
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 for "My Plan" stages
- any user with group access for Kanban stages
The method adds a Kanban or "My Plan" stage.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
fields* |
Field values (detailed description provided below) for adding a new stage |
|
isAdmin |
If set to |
Parameter fields
Required parameters are marked with *
|
Name |
Description |
|
TITLE* |
Stage title |
|
COLOR |
Stage color in RGB format |
|
AFTER_ID |
Identifier of the stage after which the new stage should be added. If not specified or equal to |
|
ENTITY_ID |
Object identifier. Can equal the If equal to An access error will be returned if the permission level is insufficient |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"fields": {
"TITLE": "Stage title",
"COLOR": "#FFAAEE",
"AFTER_ID": 1,
"ENTITY_ID": 1
},
"isAdmin": false
}' \
https://your-domain.bitrix24.com/rest/_USER_ID_/_CODE_/task.stages.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Authorization: YOUR_ACCESS_TOKEN" \
-d '{
"fields": {
"TITLE": "Stage title",
"COLOR": "#FFAAEE",
"AFTER_ID": 1,
"ENTITY_ID": 1
},
"isAdmin": false
}' \
https://your-domain.bitrix24.com/rest/task.stages.add
// 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
// ID of the added stage returned in result
// Shape of the payload returned in result (match the "response handling" section of the page)
type StageAddResult = number
try {
const response = await $b24.actions.v2.call.make<StageAddResult>({
method: 'task.stages.add',
params: {
fields: {
TITLE: 'Stage title',
COLOR: '#FFAAEE',
AFTER_ID: 1,
ENTITY_ID: 1,
},
isAdmin: false,
},
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('New stage ID:', 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 addTaskStage() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'task.stages.add',
params: {
fields: {
TITLE: 'Stage title',
COLOR: '#FFAAEE',
AFTER_ID: 1,
ENTITY_ID: 1,
},
isAdmin: false,
},
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('New stage ID:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addTaskStage)
</script>
try {
$response = $b24Service
->core
->call(
'task.stages.add',
[
'fields' => [
'TITLE' => 'Stage title',
'COLOR' => '#FFAAEE',
'AFTER_ID' => 1,
'ENTITY_ID' => 1
],
'isAdmin' => false,
]
);
$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 adding task stage: ' . $e->getMessage();
}
BX24.callMethod(
'task.stages.add',
{
fields: {
TITLE: 'Stage title',
COLOR: '#FFAAEE',
AFTER_ID: 1,
ENTITY_ID: 1
},
isAdmin: false,
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.info(result.data());
}
}
);
require_once('crest.php'); // include CRest PHP SDK
$fields = [
"TITLE" => "Stage title",
"COLOR" => "#FFAAEE",
"AFTER_ID" => 1,
"ENTITY_ID" => 1
];
// execute request to REST API
$result = CRest::call(
'task.stages.add',
[
'fields' => $fields,
'isAdmin' => false
]
);
// Process the response from Bitrix24
if ($result['error']) {
echo 'Error: '.$result['error_description'];
} else {
print_r($result['result']);
}
Response Handling
HTTP Status: 200
{
"result": 1
}
Returned Data
|
Name |
Description |
|
result |
Identifier of the added stage |
Error Handling
HTTP Status: 400
{
"error": "EMPTY_TITLE",
"error_description": "Stage title is not specified"
}
|
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 |
|
|
Stage title is not specified |
|
|
You do not have permission to manage stages |
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
- Stages of Kanban and "My Planner": Overview of Methods
- Update Kanban Stage or "My Plan" task.stages.update
- Get the List of Kanban Stages or "My Plan" task.stages.get
- Check the Ability to Move Task task.stages.canmovetask
- Move Task from One Stage to Another task.stages.movetask
- Delete a Kanban or "My Plan" Stage task.stages.delete