Update the stage of the kanban or "My Planner" task.stages.update

Scope: task

Who can execute the method:

any user for "My Planner" stages

any user with access to the group for kanban stages

The method updates the stages of the kanban or "My Planner".

The method is also used to move a stage from one position to another. To do this, simply pass the required AFTER_ID.

Method Parameters

Required parameters are marked with *

Name `type`	Description
id* `integer`	Identifier of the stage
fields* `array`	Field values (detailed description provided below) for updating the kanban or "My Planner" stage
isAdmin `boolean`	If set to `true`, permission checks will not occur, provided that the requester is an administrator of the account

Parameter fields

Name `type`	Description
TITLE `string`	Title of the stage
COLOR `string`	Color of the stage in RGB format
AFTER_ID `integer`	Identifier of the stage after which the new stage should be added. If not specified or equal to `0`, it will be added at the beginning

When updating a group stage with insufficient permission level, an access error is returned.

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -d '{
        "id": 5,
        "fields": {
            "TITLE": "New Stage",
            "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": "New Stage",
            "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' => "New Stage",
                '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: "New Stage",
            SORT: 200,
            COLOR: "FF5733"
        };
        BX24.callMethod(
            'task.stages.update',
            {
                id: stageId,
                fields: fields
            },
            function(res)
            {
                console.log(res);
            }
        );

require_once('crest.php'); // connect CRest PHP SDK
        
        $stageId = 5;
        $fields = [
            "TITLE" => "New Stage",
            "SORT" => 200,
            "COLOR" => "FF5733"
        ];
        
        // execute request to REST API
        $result = CRest::call(
            'task.stages.update',
            [
                'id' => $stageId,
                'fields' => $fields
            ]
        );
        
        // Process the response from Bitrix24
        if ($result['error']) {
            echo 'Error: '.$result['error_description'];
        } else {
            print_r($result['result']);
        }

Response Handling

HTTP Status: 200

{
            "result": true
        }

Returned Data

Name `type`	Description
result `boolean`	Returns `true` if the stage was successfully updated

Error Handling

HTTP status: 400

{
            "error": "ACCESS_DENIED",
            "error_description": "You cannot modify stages in this group"
        }

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `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
`ACCESS_DENIED`	You cannot modify stages in this group
`NOT_FOUND`	Stage not found

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Add a Kanban Stage or "My Planner"

Get a List of Kanban Stages or "My Planner"

Update the stage of the kanban or "My Planner" task.stages.update

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning