Create or Update a Scrum Task tasks.api.scrum.task.update

Scope: task

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

This method creates or updates a Scrum task. You will be able to:

create a task in Scrum
move a task from another project
transfer it between the backlog and sprints
change story points
link an epic

A task must be created using the tasks.task.add method or updated using the tasks.task.update method. Linking the task to Scrum is specified in the group identifier parameter GROUP_ID.

You can obtain the group identifier using the create new group method or the get group list method. A group is considered Scrum if the SCRUM_MASTER_ID field is filled.

Method Parameters

Name `type`	Description
id* `integer`	Task identifier
fields* `object`	An object containing records about the Scrum task (detailed description provided below) in the following structure: `fields: { entityId: 'value' storyPoints: 'value', epicId: 'value', sort: 'value' }`

Parameter fields

Name `type`	Description
entityId `integer`	Identifier of the backlog or sprint. If the value is not specified, Bitrix24 will automatically add the task to the Scrum backlog if it exists
storyPoints `string`	Story Points — a relative estimate of the task's complexity. Can have a string value
epicId `integer`	Epic identifier
sort `integer`	Sorting

Code Examples

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":1,"fields":{"epicId":1,"storyPoints":"8","entityId":2}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/tasks.api.scrum.task.update

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":1,"fields":{"epicId":1,"storyPoints":"8","entityId":2},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/tasks.api.scrum.task.update

try
        {
        	const response = await $b24.callMethod(
        		'tasks.api.scrum.task.update',
        		{
        			id: 1,
        			fields: 
        			{
        				epicId: 1,
        				storyPoints: '8',
        				entityId: 2
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.log(result);
        }
        catch( error )
        {
        	console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'tasks.api.scrum.task.update',
                    [
                        'id' => 1,
                        'fields' => [
                            'epicId'      => 1,
                            'storyPoints' => '8',
                            'entityId'    => 2
                        ]
                    ]
                );
        
            $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 updating scrum task: ' . $e->getMessage();
        }

BX24.callMethod(
            'tasks.api.scrum.task.update',
            {
                id: 1,
                fields: 
                {
                    epicId: 1,
                    storyPoints: '8',
                    entityId: 2
                }
            },
            function(res)
            {
                console.log(res);
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'tasks.api.scrum.task.update',
            [
                'id' => 1,
                'fields' => [
                    'epicId' => 1,
                    'storyPoints' => '8',
                    'entityId' => 2
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
            "status" : "success",
            "data" : true,
            "errors" : []
        }

Returned Data

Name `type`	Description
status `string`	Response status. Possible values: `success` `error`
data `boolean`\|`null`	Returns: `true` — in case of success `null` — in case of error
errors `array`	Array of errors

Error Handling

HTTP status: 400

{
            "error": 0,
            "error_description": "Task 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`	Epic not found	Epic not found
`0`	Task not found	Task not found
`0`	Access denied	Access denied
`0`	Item not created	Task not added to Scrum

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

Get Scrum Task Fields by ID

Create or Update a Scrum Task tasks.api.scrum.task.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