Для AI-агентов: markdown этой страницы — /docs-content/scrum/sprints/update.md индекс документации — /llms.txt

Обновить спринт

PATCH /v1/scrum/sprints/:id

Меняет название, даты, порядок или статус спринта. Тело запроса плоское, без обёртки fields, передаются только изменяемые поля.

Параметры

Параметр Тип Обяз. Описание
Параметрid (path) Типnumber Обяз.да ОписаниеID спринта. Получите его через список спринтов или активный спринт

Поля запроса (body)

Хотя бы одно поле обязательно.

Поле Тип Описание
Полеname Типstring ОписаниеНазвание спринта
ПолеdateStart Типstring | number ОписаниеНачало спринта: дата 2026-11-02 или Unix timestamp
ПолеdateEnd Типstring | number ОписаниеОкончание спринта: дата 2026-11-16 или Unix timestamp
Полеstatus Типstring Описаниеplanned, active или completed
Полеsort Типnumber ОписаниеПорядок спринта внутри проекта
ПолеgroupId Типnumber ОписаниеID Scrum-проекта. Список групп: GET /v1/workgroups
ПолеcreatedBy Типnumber ОписаниеID пользователя-создателя. Список: GET /v1/users
ПолеmodifiedBy Типnumber ОписаниеID пользователя, изменившего спринт. Список: GET /v1/users

Примеры

curl — личный ключ

Terminal 
curl -X PATCH https://vibecode.bitrix24.tech/v1/scrum/sprints/45 \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Спринт 11", "dateEnd": "2026-11-16" }'

curl — OAuth-приложение

Terminal 
curl -X PATCH https://vibecode.bitrix24.tech/v1/scrum/sprints/45 \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Спринт 11", "dateEnd": "2026-11-16" }'

JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/scrum/sprints/45', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ name: 'Спринт 11', dateEnd: '2026-11-16' }),
})

const { data: sprint } = await res.json()
console.log(sprint.name, sprint.dateEnd)

JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/scrum/sprints/45', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ name: 'Спринт 11', dateEnd: '2026-11-16' }),
})

const { data: sprint } = await res.json()
console.log(sprint.name, sprint.dateEnd)

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean Описаниеtrue при успешном обновлении
Полеdata Типobject ОписаниеСпринт после обновления
Полеdata.id Типnumber ОписаниеID спринта
Полеdata.groupId Типnumber ОписаниеID Scrum-проекта
Полеdata.entityType Типstring ОписаниеТип записи, sprint
Полеdata.name Типstring ОписаниеНазвание спринта
Полеdata.goal Типstring ОписаниеЦель спринта
Полеdata.sort Типnumber ОписаниеПорядок спринта внутри проекта
Полеdata.createdBy Типnumber ОписаниеID пользователя-создателя
Полеdata.modifiedBy Типnumber ОписаниеID пользователя, изменившего спринт последним
Полеdata.dateStart Типstring ОписаниеНачало спринта в формате ISO 8601
Полеdata.dateEnd Типstring ОписаниеОкончание спринта в формате ISO 8601
Полеdata.status Типstring Описаниеplanned, active или completed

Пример ответа

JSON 
{
  "success": true,
  "data": {
    "id": 45,
    "groupId": 211,
    "entityType": "sprint",
    "name": "Спринт 11",
    "goal": "",
    "sort": 1,
    "createdBy": 1317,
    "modifiedBy": 1317,
    "dateStart": "2026-11-02T00:00:00+03:00",
    "dateEnd": "2026-11-16T00:00:00+03:00",
    "status": "planned"
  }
}

Пример ответа при ошибке

404 — спринта с таким ID нет:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Sprint not found"
  }
}

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_PARAMS ОписаниеПустое тело, поле вне таблицы, status вне списка значений или ID не положительное целое
HTTP404 КодENTITY_NOT_FOUND ОписаниеСпринта с таким id нет
HTTP403 КодSCOPE_DENIED ОписаниеКлючу не хватает скоупа task
HTTP403 КодWRITE_BLOCKED_READONLY_KEY ОписаниеКлюч работает только на чтение
HTTP401 КодTOKEN_MISSING ОписаниеУ ключа нет настроенных токенов

Полный список общих ошибок API — Ошибки.

Известные особенности

  • Статус меняется без проверок запуска. status: "active" делает запланированный спринт активным, даже если в нём нет задач. Штатный запуск такой спринт не пройдёт.

Смотрите также