Create a Scrum Kanban Stage tasks.api.scrum.kanban.addStage

Scope: task

Who can execute the method: any user

This method creates a Scrum Kanban stage.

A Scrum Kanban must include stages of type new NEW and final FINISH.

Use this method only for active sprints, meaning with the field "status": "active".

Method Parameters

Required parameters are marked with *

Name `type`	Description
fields* `object`	Fields corresponding to the available list of fields tasks.api.scrum.kanban.getFields (detailed description provided below)

Parameter fields

Required parameters are marked with *

Name `type`	Description
sprintId* `integer`	Sprint identifier. You can obtain the identifier using the method tasks.api.scrum.sprint.list
name* `string`	Name of the Kanban stage
type `string`	Type of the Kanban stage. Possible values: `NEW`, `WORK`, `FINISH`
sort `integer`	Sort order. The field value must be a multiple of `100`
color `string`	Color of the Kanban stage

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" \
        -H "Accept: application/json" \
        -d '{"fields":{"sprintId":1,"name":"First Stage","type":"NEW","color":"00C4FB","sort":100}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/tasks.api.scrum.kanban.addStage

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"sprintId":1,"name":"First Stage","type":"NEW","color":"00C4FB","sort":100},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/tasks.api.scrum.kanban.addStage

try
        {
        	const response = await $b24.callMethod(
        		'tasks.api.scrum.kanban.addStage',
        		{
        			"fields": {
        				"sprintId": 1,
        				"name": "First Stage",
        				"type": "NEW",
        				"color": "00C4FB",
        				"sort": 100,
        			},
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'tasks.api.scrum.kanban.addStage',
                    [
                        'fields' => [
                            'sprintId' => 1,
                            'name' => 'First Stage',
                            'type' => 'NEW',
                            'color' => '00C4FB',
                            'sort' => 100,
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            // Your required data processing logic
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding stage: ' . $e->getMessage();
        }

BX24.callMethod(
            'tasks.api.scrum.kanban.addStage',
            {
                "fields": {
                    "sprintId": 1,
                    "name": "First Stage",
                    "type": "NEW",
                    "color": "00C4FB",
                    "sort": 100,
                },
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'tasks.api.scrum.kanban.addStage',
            [
                'fields' => [
                    'sprintId' => 1,
                    'name' => 'First Stage',
                    'type' => 'NEW',
                    'sort' => 100,
                    'color' => '00C4FB',
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
            "result": 5,
            "time": {
                "start": 1712137817.343984,
                "finish": 1712137817.605804,
                "duration": 0.26182007789611816,
                "processing": 0.018325090408325195,
                "date_start": "2024-04-03T12:50:17+02:00",
                "date_finish": "2024-04-03T12:50:17+02:00"
            }
        }

Error Handling

HTTP status: 400

{
            "error": 0,
            "error_description": "Sprint not found"
        }

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	Value
`0`	`Sprint id not found`	Required field `sprintId` is not filled
`0`	`Sprint not found`	An unknown sprint identifier was provided
`0`	`Access denied`	Access is denied
`0`	`Incorrect name format`	Required field `name` is not filled
`0`	Unknown error

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

Create a Scrum Kanban Stage tasks.api.scrum.kanban.addStage

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Code ExamplesCode Examples

Response HandlingResponse Handling

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning