Add Sprint in Scrum tasks.api.scrum.sprint.add

Scope: task

Who can execute the method: any user with access to Scrum

The method tasks.api.scrum.sprint.add adds a sprint to Scrum.

Method Parameters

Required parameters are marked with *

Name `type`	Description
fields* `object`	Object containing sprint data

Parameter fields

Required parameters are marked with *

Name `type`	Description
groupId* `integer`	Identifier of the group (Scrum) to which the sprint belongs. The identifier can be obtained using the method tasks.api.scrum.sprint.get for an existing sprint
name* `string`	Name of the sprint
sort `integer`	Sorting
dateStart `string`	Start date of the sprint. Available formats: `ISO 8601`, `timestamp`
dateEnd `string`	End date of the sprint. Available formats: `ISO 8601`, `timestamp`
status `string`	Status of the sprint. Available values: `active`, `planned`, `completed`

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": {
            "name": "Sprint 1",
            "groupId": 1,
            "createdBy": 1,
            "sort": 1,
            "status": "planned",
            "dateStart": "2021-11-22T00:00:00+02:00",
            "dateEnd": "2021-11-29T00:00:00+02:00"
        }
        }' \
        https://your-domain.bitrix24.com/rest/_USER_ID_/_CODE_/tasks.api.scrum.sprint.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Authorization: YOUR_ACCESS_TOKEN" \
        -d '{
        "fields": {
            "name": "Sprint 1",
            "groupId": 1,
            "createdBy": 1,
            "sort": 1,
            "status": "planned",
            "dateStart": "2021-11-22T00:00:00+02:00",
            "dateEnd": "2021-11-29T00:00:00+02:00"
        }
        }' \
        https://your-domain.bitrix24.com/rest/tasks.api.scrum.sprint.add

try
        {
        	const response = await $b24.callMethod(
        		'tasks.api.scrum.sprint.add',
        		{
        			fields: {
        				name: name,
        				groupId: groupId,
        				createdBy: createdBy,
        				sort: sort,
        				status: status,
        				dateStart: dateStart,
        				dateEnd: dateEnd,
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.log(result);
        }
        catch( error )
        {
        	console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'tasks.api.scrum.sprint.add',
                    [
                        'fields' => [
                            'name'      => $name,
                            'groupId'   => $groupId,
                            'createdBy' => $createdBy,
                            'sort'      => $sort,
                            'status'    => $status,
                            'dateStart' => $dateStart,
                            'dateEnd'   => $dateEnd,
                        ],
                    ]
                );
        
            $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 sprint: ' . $e->getMessage();
        }

const groupId = 1;
        const name = 'Sprint 1';
        const createdBy = 1;
        const sort = 1;
        const status = 'planned';
        const dateStart = '2021-11-22T00:00:00+02:00';
        const dateEnd = '2021-11-29T00:00:00+02:00';
        BX24.callMethod(
            'tasks.api.scrum.sprint.add',
            {
                fields: {
                    name: name,
                    groupId: groupId,
                    createdBy: createdBy,
                    sort: sort,
                    status: status,
                    dateStart: dateStart,
                    dateEnd: dateEnd,
                }
            },
            function(res)
            {
                console.log(res);
            }
        );

require_once('crest.php'); // connect CRest PHP SDK
        
        $groupId = 1;
        $name = 'Sprint 1';
        $createdBy = 1;
        $sort = 1;
        $status = 'planned';
        $dateStart = '2021-11-22T00:00:00+02:00';
        $dateEnd = '2021-11-29T00:00:00+02:00';
        
        // execute request to REST API
        $result = CRest::call(
            'tasks.api.scrum.sprint.add',
            [
                'fields' => [
                    'name' => $name,
                    'groupId' => $groupId,
                    'createdBy' => $createdBy,
                    'sort' => $sort,
                    'status' => $status,
                    'dateStart' => $dateStart,
                    'dateEnd' => $dateEnd
                ]
            ]
        );
        
        // Process response from Bitrix24
        if (isset($result['error'])) {
            echo 'Error: '.$result['error_description'];
        } else {
            print_r($result['result']);
        }

Response Handling

HTTP Status: 200

{
            "result":
            {
                "id": 1,
                "groupId": 1,
                "entityType": "sprint",
                "name": "Sprint 1",
                "goal": "",
                "sort": 1,
                "createdBy": 1,
                "modifiedBy": 1,
                "dateStart": "2021-11-22T00:00:00+02:00",
                "dateEnd": "2021-11-29T00:00:00+02:00",
                "status": "planned"
            }
        }

Returned Data

Name `type`	Description
result `object`	Object containing sprint data
id `integer`	Identifier of the sprint
groupId `integer`	Identifier of the group (Scrum) to which the sprint belongs
entityType `string`	Entity type (in this case `sprint`)
name `string`	Name of the sprint
goal `string`	Goal of the sprint. Set only in the interface when starting the sprint
sort `integer`	Sorting
createdBy `integer`	Identifier of the user who created the sprint
modifiedBy `integer`	Identifier of the user who modified the sprint
dateStart `string`	Start date of the sprint in `ISO 8601` format
dateEnd `string`	End date of the sprint in `ISO 8601` format
status `string`	Status of the sprint

Error Handling

HTTP Status: 400

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

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	Error Message	Description
`0`	`Access denied`	No access to Scrum
`0`	`Sprint not created`	Failed to create sprint
`0`	`Incorrect dateStart format`	Invalid start date format for the sprint
`0`	`Incorrect dateEnd format`	Invalid end date format for the sprint
`0`	`createdBy user not found`	User in the "creator" field not found
`0`	`modifiedBy user not found`	User in the "last modified by" field not found
`100`	`Could not find value for parameter {fields}`	Incorrect parameter name or parameter not set
`100`	`Invalid value {stringValue} to match with parameter {fields}. Should be value of type array`	Invalid parameter type

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 Sprint

Add Sprint in Scrum tasks.api.scrum.sprint.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