Add a Kanban or "My Planner" Stage task.stages.add

Scope: task

Who can execute the method:

any user for "My Planner" stages

any user with group access for Kanban stages

The method adds a Kanban or "My Planner" stage.

Method Parameters

Required parameters are marked with *

Name `type`	Description
fields* `object`	Field values (detailed description provided below) for adding a new stage
isAdmin `boolean`	If set to `true`, permission checks will not occur, provided the requester is an account administrator

Parameter fields

Required parameters are marked with *

Name `type`	Description
TITLE* `string`	Stage title
COLOR `string`	Stage color 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
ENTITY_ID `integer`	Object identifier. Can equal the `ID` of the group, in which case the stage will be added to the group's Kanban. If equal to `0` or absent, the stage is added to "My Planner" of the current user. An access permission error will be displayed if the permission level is insufficient

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 '{
        "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

try
        {
        	const response = await $b24.callMethod(
        		'task.stages.add',
        		{
        			fields: {
        				TITLE: 'Stage Title',
        				COLOR: '#FFAAEE',
        				AFTER_ID: 1,
        				ENTITY_ID: 1
        			},
        			isAdmin: false,
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }

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 data processing logic
            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 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 `type`	Description
result `integer`	Identifier of the added stage

Error Handling

HTTP status: 400

{
            "error": "EMPTY_TITLE",
            "error_description": "Stage title is not specified"
        }

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
`EMPTY_TITLE`	Stage title is not specified
`ACCESS_DENIED`	You cannot manage stages

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

Overview of Methods

Update a Kanban Stage or "My Planner"

Add a Kanban or "My Planner" Stage task.stages.add

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