# tasks.api.scrum.sprint.update

URL: https://chugunov.pro/api-bitrix24/sonet-group/scrum/sprint/tasks-api-scrum-sprint-update/
Проверено на Битрикс24 REST API, обновлено 11.09.2026 (ревизия источника fb39d6c).
Источник: официальная документация Битрикс24 (bitrix-tools/b24-rest-docs, лицензия MIT, © Bitrix). Справочник независимый, официальной документацией не является.

Изменить спринт
Scope: `task`
Кто может выполнять метод: любой пользователь, имеющий доступ к Скраму

## Описание

Метод `tasks.api.scrum.sprint.update` изменяет спринт.

## Параметры

- `id` `integer` — обязательный. Идентификатор спринта
- `fields` `object` — обязательный. Объект с данными спринта

### Параметр fields

- `groupId` `integer` — необязательный. Идентификатор группы (Скрама), к которой относится спринт. 
  Идентификатор можно получить методом [tasks.api.scrum.sprint.get](https://chugunov.pro/api-bitrix24/sonet-group/scrum/sprint/tasks-api-scrum-sprint-get/) для уже существующего спринта
- `name` `string` — необязательный. Название спринта
- `sort` `integer` — необязательный. Сортировка
- `dateStart` `string` — необязательный. Дата начала спринта. Доступные форматы: `ISO 8601`, `timestamp`
- `dateEnd` `string` — необязательный. Дата окончания спринта. Доступные форматы: `ISO 8601`, `timestamp`
- `status` `string` — необязательный. Статус спринта. Доступные значения: `active`, `planned`, `completed`

## Ответ

HTTP-статус: 200

```json
{
    "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"
    }
}
```

### Возвращаемые данные

- `result` `object`. Объект, содержащий данные о спринте
- `id` `integer`. Идентификатор спринта
- `groupId` `integer`. Идентификатор группы (Скрама), к которой относится спринт
- `entityType` `string`. Тип сущности (в данном случае `sprint`)
- `name` `string`. Название спринта
- `goal` `string`. Цель спринта. Устанавливается только в интерфейсе при запуске спринта
- `sort` `integer`. Сортировка
- `createdBy` `integer`. Идентификатор пользователя, создавшего спринт
- `modifiedBy` `integer`. Идентификатор пользователя, изменившего спринт
- `dateStart` `string`. Дата начала спринта в формате `ISO 8601`
- `dateEnd` `string`. Дата окончания спринта в формате `ISO 8601`
- `status` `string`. Статус спринта

## Ошибки

HTTP-статус: 400

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

- `0` — `Access denied`. Нет доступа к Скраму
- `0` — `Sprint not created`. Не удалось создать спринт
- `0` — `Incorrect dateStart format`. Неверный формат времени начала спринта
- `0` — `Incorrect dateEnd format`. Неверный формат времени окончания спринта
- `0` — `createdBy user not found`. Пользователь в поле «создатель» не найден
- `0` — `modifiedBy user not found`. Пользователь в поле «последний изменивший» не найден
- `0` — `Unable to add two active sprint`. В группе не может быть двух спринтов со статусом «активен»
- `0` — `Incorrect sprint status`. Статус не состоит в списке доступных для установки статусов спринта
- `100` — `Could not find value for parameter {fields}`. Неверно указано имя параметра или не задан параметр
- `100` — `Invalid value {stringValue} to match with parameter {fields}. Should be value of type array`. Неверный тип параметра

## Примеры запроса

### cURL (Webhook)

```bash
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 (OAuth)

```bash
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
```

### JS (TS)

```ts
// 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)
}
```

### JS (UMD)

```html
<!-- 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>
```

### Python

```python
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",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")
```

### PHP

```php
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);
    // Нужная вам логика обработки данных
    processData($result);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error updating sprint: ' . $e->getMessage();
}
```

### BX24.js

```js
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);
    }
);
```

### PHP CRest

```php
require_once('crest.php'); // подключение CRest PHP SDK

// выполнение запроса к 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'
        ]
    ]
);

// Обработка ответа от Битрикс24
if (isset($result['error'])) {
    echo 'Error: '.$result['error_description'];
} else {
    print_r($result['result']);
}
```

### Go

```go
// client и ctx уже созданы — см. раздел «SDK для Go»
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("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.GroupID)
```

Оригинал в официальной документации: https://apidocs.bitrix24.ru/api-reference/sonet-group/scrum/sprint/tasks-api-scrum-sprint-update.html