Update Sprint tasks.api.scrum.sprint.update
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.
Scope:
taskWho can execute the method: any user with access to Scrum
The method tasks.api.scrum.sprint.update updates a sprint.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
id* |
Identifier of the sprint |
|
fields* |
Object containing sprint data |
Parameter fields
|
Name |
Description |
|
groupId |
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 |
Name of the sprint |
|
sort |
Sorting |
|
dateStart |
Start date of the sprint. Available formats: |
|
dateEnd |
End date of the sprint. Available formats: |
|
status |
Status of the sprint. Available values: |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"id": 2,
"fields": {
"name": "Sprint 2",
"groupId": 1,
"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.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Authorization: YOUR_ACCESS_TOKEN" \
-d '{
"id": 2,
"fields": {
"name": "Sprint 2",
"groupId": 1,
"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.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, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type SprintResult = {
id: number
groupId: number
entityType: string
name: string
goal: string
sort: number
createdBy: number
modifiedBy: number
dateStart: ISODate | null
dateEnd: ISODate | null
status: string
}
try {
const response = await $b24.actions.v2.call.make<SprintResult>({
method: 'tasks.api.scrum.sprint.update',
params: {
id: 2,
fields: {
name: 'Sprint 2',
groupId: 1,
dateStart: '2021-11-22T00:00:00+02:00',
dateEnd: '2021-11-29T00:00:00+02:00',
},
},
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('Updated sprint:', result.id, result.name, result.status)
}
} 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 updateSprint() {
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.sprint.update',
params: {
id: 2,
fields: {
name: 'Sprint 2',
groupId: 1,
dateStart: '2021-11-22T00:00:00+02:00',
dateEnd: '2021-11-29T00:00:00+02:00',
},
},
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('Updated sprint:', result.id, result.name, result.status)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', updateSprint)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.tasks.api.scrum.sprint.update(
bitrix_id=2,
fields={
"name": "Sprint 2",
"groupId": 1,
"dateStart": "2021-11-22T00:00:00+02:00",
"dateEnd": "2021-11-29T00:00:00+02:00",
},
).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.sprint.update',
[
'id' => $sprintId,
'fields' => [
'name' => $name,
'groupId' => $groupId,
'dateStart' => $dateStart,
'dateEnd' => $dateEnd,
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// The data processing logic you need
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error updating sprint: ' . $e->getMessage();
}
const sprintId = 2;
const groupId = 1;
const name = 'Sprint 2';
const dateStart = '2021-11-22T00:00:00+02:00';
const dateEnd = '2021-11-29T00:00:00+02:00';
BX24.callMethod(
'tasks.api.scrum.sprint.update',
{
id: sprintId,
fields: {
name: name,
groupId: groupId,
dateStart: dateStart,
dateEnd: dateEnd,
}
},
function(res)
{
console.log(res);
}
);
require_once('crest.php'); // connecting the CRest PHP SDK
// executing a request to the REST API
$result = CRest::call(
'tasks.api.scrum.sprint.update',
[
'id' => 2,
'fields' => [
'name' => 'Sprint 2',
'groupId' => 1,
'dateStart' => '2021-11-22T00:00:00+02:00',
'dateEnd' => '2021-11-29T00:00:00+02:00'
]
]
);
// Processing the response from Bitrix24
if (isset($result['error'])) {
echo 'Error: '.$result['error_description'];
} else {
print_r($result['result']);
}
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "tasks.api.scrum.sprint.update", b24.Params{
"id": 2,
"fields": b24.Params{
"name": "Sprint 2",
"groupId": 1,
"dateStart": "2021-11-22T00:00:00+02:00",
"dateEnd": "2021-11-29T00:00:00+02:00",
},
})
if err != nil {
return fmt.Errorf("tasks.api.scrum.sprint.update: %w", err)
}
var item struct {
ID b24.ID `json:"id"`
GroupID b24.ID `json:"groupId"`
EntityType string `json:"entityType"`
Name string `json:"name"`
Goal string `json:"goal"`
Sort int `json:"sort"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.ID, item.GroupID)
Response Handling
HTTP status: 200
{
"result":
{
"id": 2,
"groupId": 1,
"entityType": "sprint",
"name": "Sprint 2",
"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 |
Description |
|
result |
Object containing sprint data |
|
id |
Identifier of the sprint |
|
groupId |
Identifier of the group (Scrum) to which the sprint belongs |
|
entityType |
Entity type (in this case |
|
name |
Name of the sprint |
|
goal |
Goal of the sprint. Set only in the interface when starting the sprint |
|
sort |
Sorting |
|
createdBy |
Identifier of the user who created the sprint |
|
modifiedBy |
Identifier of the user who modified the sprint |
|
dateStart |
Start date of the sprint in |
|
dateEnd |
End date of the sprint in |
|
status |
Status of the sprint |
Error Handling
HTTP status: 400
{
"error": 0,
"error_description": "Sprint not found"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Code |
Error message |
Description |
|
|
|
No access to Scrum |
|
|
|
Failed to create sprint |
|
|
|
Invalid start date format for the sprint |
|
|
|
Invalid end date format for the sprint |
|
|
|
User in the "creator" field not found |
|
|
|
User in the "last modified by" field not found |
|
|
|
There cannot be two sprints with the status "active" in the group |
|
|
|
Status is not in the list of available sprint statuses |
|
|
|
Incorrect parameter name or parameter not set |
|
|
|
Invalid parameter 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 |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
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 |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was 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 |
|
|
|
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 |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
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
- Add Sprint in Scrum tasks.api.scrum.sprint.add
- Start Sprint tasks.api.scrum.sprint.start
- Complete the Active Sprint of the Selected Scrum tasks.api.scrum.sprint.complete
- Get Sprint Fields by Its Identifier tasks.api.scrum.sprint.get
- Get a List of Sprints tasks.api.scrum.sprint.list
- Delete Sprint tasks.api.scrum.sprint.delete
- Get a List of Available Fields for the Sprint tasks.api.scrum.sprint.getFields