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

Создать спринт

POST /v1/scrum/sprints

Создаёт спринт в Scrum-проекте. Тело запроса плоское, без обёртки fields.

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

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

Без name или createdBy спринт не создаётся: приходит 422 BITRIX_ERROR с сообщением Unable to add sprint.

Примеры

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/scrum/sprints \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "groupId": 211,
    "name": "Спринт 12",
    "dateStart": "2026-11-02",
    "dateEnd": "2026-11-16",
    "status": "planned",
    "createdBy": 1317
  }'

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/scrum/sprints \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "groupId": 211,
    "name": "Спринт 12",
    "dateStart": "2026-11-02",
    "dateEnd": "2026-11-16",
    "status": "planned",
    "createdBy": 1317
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/scrum/sprints', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    groupId: 211,
    name: 'Спринт 12',
    dateStart: '2026-11-02',
    dateEnd: '2026-11-16',
    status: 'planned',
    createdBy: 1317,
  }),
})

const { data } = await res.json()
console.log('Sprint ID:', data.id)

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

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

const { data } = await res.json()
console.log('Sprint ID:', data.id)

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean Описаниеtrue при успешном создании, HTTP-статус 201
Поле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": 53,
    "groupId": 211,
    "entityType": "sprint",
    "name": "Спринт 12",
    "goal": "",
    "sort": 0,
    "createdBy": 1317,
    "modifiedBy": 1317,
    "dateStart": "2026-11-02T00:00:00+03:00",
    "dateEnd": "2026-11-16T00:00:00+03:00",
    "status": "planned"
  }
}

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

422 — не передан name или createdBy:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "Unable to add sprint",
    "b24Code": "0"
  }
}

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_PARAMS ОписаниеНе передан groupId, dateStart, dateEnd или status, передано поле вне таблицы, status вне списка значений или ID не положительное целое
HTTP422 КодBITRIX_ERROR ОписаниеUnable to add sprint — не передан name или createdBy
HTTP422 КодBITRIX_ERROR ОписаниеAccess denied — группы с таким ID нет, она не Scrum-проект или к ней нет доступа
HTTP403 КодSCOPE_DENIED ОписаниеКлючу не хватает скоупа task
HTTP403 КодWRITE_BLOCKED_READONLY_KEY ОписаниеКлюч работает только на чтение
HTTP401 КодTOKEN_MISSING ОписаниеУ ключа нет настроенных токенов

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

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