task.stages.update
Обновить стадию канбана или «Моего плана»
Описание
Метод task.stages.update обновляет стадии канбана или «Моего плана».
Метод также применяется для перемещения стадии с одной позиции на другую. Для этого достаточно передать нужный AFTER_ID.
Параметры
id
integer
обязательный
Идентификатор стадии
fields
array
обязательный
Значения полей (подробное описание приведено ниже) для обновления стадии канбана или «Моего плана»
isAdmin
boolean
необязательный
Если установлено true, то проверки прав происходить не будет. При условии, что запрашивающий является администратором портала
Параметр fields
TITLE
string
необязательный
Заголовок стадии
COLOR
string
необязательный
Цвет стадии в формате RGB
AFTER_ID
integer
необязательный
Идентификатор стадии, после которой надо добавить новую стадию.
Если не указано или равно 0, то добавится в начало
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"id": 5,
"fields": {
"TITLE": "Новая стадия",
"SORT": 200,
"COLOR": "FF5733"
}
}' \
https://your-domain.bitrix24.com/rest/_USER_ID_/_CODE_/task.stages.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Authorization: YOUR_ACCESS_TOKEN" \
-d '{
"id": 5,
"fields": {
"TITLE": "Новая стадия",
"SORT": 200,
"COLOR": "FF5733"
}
}' \
https://your-domain.bitrix24.com/rest/task.stages.update
// 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.update',
params: {
id: 5,
fields: {
TITLE: 'New Stage',
SORT: 200,
COLOR: 'FF5733',
},
},
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 updated:', 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 updateStage() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'task.stages.update',
params: {
id: 5,
fields: {
TITLE: 'New Stage',
SORT: 200,
COLOR: 'FF5733',
},
},
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 updated:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', updateStage)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
fields = {
"TITLE": "Новая стадия",
"SORT": 200,
"COLOR": "FF5733",
}
try:
bitrix_response = client.task.stages.update(
bitrix_id=5,
fields=fields,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
try {
$stageId = 5;
$fields = [
'TITLE' => "Новая стадия",
'SORT' => 200,
'COLOR' => "FF5733"
];
$response = $b24Service
->core
->call(
'task.stages.update',
[
'id' => $stageId,
'fields' => $fields
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error updating task stage: ' . $e->getMessage();
}
const stageId = 5;
const fields = {
TITLE: "Новая стадия",
SORT: 200,
COLOR: "FF5733"
};
BX24.callMethod(
'task.stages.update',
{
id: stageId,
fields: fields
},
function(res)
{
console.log(res);
}
);
require_once('crest.php'); // подключение CRest PHP SDK
$stageId = 5;
$fields = [
"TITLE" => "Новая стадия",
"SORT" => 200,
"COLOR" => "FF5733"
];
// выполнение запроса к REST API
$result = CRest::call(
'task.stages.update',
[
'id' => $stageId,
'fields' => $fields
]
);
// Обработка ответа от Битрикс24
if ($result['error']) {
echo 'Error: '.$result['error_description'];
} else {
print_r($result['result']);
}
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "task.stages.update", b24.Params{
"id": 5,
"fields": b24.Params{
"TITLE": "Новая стадия",
"SORT": 200,
"COLOR": "FF5733",
},
})
if err != nil {
return fmt.Errorf("task.stages.update: %w", err)
}
var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("выполнено:", ok)
Ответ
{
"result": true
}
Возвращаемые данные
result
boolean
Возвращает true в случае успешного обновления стадии
Обработка ошибок
HTTP-статус: 400
{
"error": "ACCESS_DENIED",
"error_description": "Вы не можете изменять стадии в этой группе"
}
| Код | Описание | Значение |
|---|---|---|
ACCESS_DENIED |
Вы не можете изменять стадии в этой группе | |
NOT_FOUND |
Стадия не найдена |

