Обновить стадию канбана или «Моего плана» task.stages.update

Scope: task

Кто может выполнять метод:

любой пользователь для стадий «Моего плана»

любой пользователь с доступом к группе для стадий канбана

Метод обновляет стадии канбана или «Моего плана».

Метод также применяется для перемещения стадии с одной позиции на другую. Для этого достаточно передать нужный AFTER_ID.

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

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

Название `тип`	Описание
id* `integer`	Идентификатор стадии
fields* `array`	Значения полей (подробное описание приведено ниже) для обновления стадии канбана или «Моего плана»
isAdmin `boolean`	Если установлено `true`, то проверки прав происходить не будет. При условии, что запрашивающий является администратором портала

Параметр fields

Название `тип`	Описание
TITLE `string`	Заголовок стадии
COLOR `string`	Цвет стадии в формате RGB
AFTER_ID `integer`	Идентификатор стадии, после которой надо добавить новую стадию. Если не указано или равно `0`, то добавится в начало

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

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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

try
        {
        	const response = await $b24.callMethod(
        		'task.stages.update',
        		{
        			id: stageId,
        			fields: fields
        		}
        	);
        	
        	const result = response.getData().result;
        	console.log(result);
        }
        catch( error )
        {
        	console.error('Error:', 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']);
        }

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

HTTP-Статус: 200

{
            "result": true
        }

Возвращаемые данные

Название `тип`	Описание
result `boolean`	Возвращает `true` в случае успешного обновления стадии

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

HTTP-статус: 400

{
            "error": "ACCESS_DENIED",
            "error_description": "Вы не можете изменять стадии в этой группе"
        }

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Код	Описание
`ACCESS_DENIED`	Вы не можете изменять стадии в этой группе
`NOT_FOUND`	Стадия не найдена

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

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

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

Добавить стадию канбана или «Моего плана»

Получить список стадий канбана или «Моего плана»

Обновить стадию канбана или «Моего плана» task.stages.update

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

Параметр fieldsПараметр fields

Примеры кодаПримеры кода

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

Возвращаемые данныеВозвращаемые данные

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

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

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

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