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

Choose a tool for developing with an AI agent:

  • use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
  • use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: task

Who can execute the method: a user with permission to modify the task and Scrum

The tasks.api.scrum.task.update method creates or updates a Scrum task. You can:

  • create a task in Scrum
  • transfer it between the backlog and sprints
  • change story points
  • link an epic

A task must be created using tasks.task.add or updated using tasks.task.update. In the GROUP_ID field, specify the identifier of the same Scrum that contains the backlog or sprint from entityId. The tasks.api.scrum.task.update method does not move a task between projects.

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

Required parameters are marked with *

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',
            sortFloat: 'value',
            createdBy: 'value',
            modifiedBy: 'value'
        }
        

Parameter fields

Name
type

Description

entityId
integer

Identifier of the backlog or sprint.

The parameter is required when adding a task to Scrum. For an existing Scrum task, you can omit it if you do not need to move the task between the backlog and sprints

storyPoints
string

Story Points — a relative estimate of the task's complexity.

Can have a string value

epicId
integer

Epic identifier

sort
integer

Sorting

sortFloat
float

Sorting value with a fractional part

createdBy
integer

Identifier of the user who created the Scrum task record

modifiedBy
integer

Identifier of the user who modified the Scrum task record

Code Examples

How to Use Examples in Documentation

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
        
// This snippet is an ES module: top-level await requires type="module" or a bundler.
        // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
        import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        try {
          const response = await $b24.actions.v2.call.make<boolean>({
            method: 'tasks.api.scrum.task.update',
            params: {
              id: 1,
              fields: {
                epicId: 1,
                storyPoints: '8',
                entityId: 2,
              },
            },
            requestId: Text.getUuidRfc4122()
          })
        
          // The payload is available only on a successful response
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Scrum task updated:', result)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
        <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function updateScrumTask() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'tasks.api.scrum.task.update',
                params: {
                  id: 1,
                  fields: {
                    epicId: 1,
                    storyPoints: '8',
                    entityId: 2,
                  },
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              // The payload is available only on a successful response
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Scrum task updated:', result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', updateScrumTask)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.tasks.api.scrum.task.update(
                bitrix_id=1,
                fields={
                    "epicId": 1,
                    "storyPoints": "8",
                    "entityId": 2,
                },
            ).response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected 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>';
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "tasks.api.scrum.task.update", b24.Params{
        	"id": 1,
        	"fields": b24.Params{
        		"epicId":      1,
        		"storyPoints": "8",
        		"entityId":    2,
        	},
        })
        if err != nil {
        	return fmt.Errorf("tasks.api.scrum.task.update: %w", err)
        }
        
        // The response arrives as json.RawMessage — unmarshal it
        // into a struct matching the response shape shown below on this page.
        fmt.Printf("%s\n", res.Result)
        

Response Handling

HTTP status: 200

{
            "result": true,
            "time": {
                "start": 1721402687.900315,
                "finish": 1721402694.313811,
                "duration": 6.413496017456055,
                "processing": 6.387248992919922,
                "date_start": "2024-07-19T15:24:47+00:00",
                "date_finish": "2024-07-19T15:24:54+00:00",
                "operating": 6.387217998504639
            }
        }
        

Returned Data

Name
type

Description

result
boolean

Returns true if the Scrum task was created or updated

time
time

Information about the request execution time

Error Handling

HTTP status: 400

{
            "error": 0,
            "error_description": "Task not found."
        }
        

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Code

Description

Value

0

Task id not found

The task identifier is 0

0

Entity id not found

entityId was not passed when adding the task to Scrum

0

Entity not found.

The backlog or sprint with the specified entityId was not found

0

Epic not found

Epic not found

0

Task not found.

Task not found

0

Task not found. The task must be in the project of the entity

The task and the backlog or sprint from entityId belong to different projects

0

Access denied

Access denied

0

Item not created

Task not added to Scrum

0

createdBy user not found

The user specified in createdBy was not found

0

modifiedBy user not found

The user specified in modifiedBy was not found

0

Unable to update task

Failed to save changes to the Scrum task

100

Could not find value for parameter

The required id parameter is missing

100

Could not find value for parameter

The required fields parameter is missing

100

Invalid value {stringValue} to match with parameter {id}. Should be value of type int.

The id parameter has an invalid type

Statuses and System Error Codes

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not found!

No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning