[{"data":1,"prerenderedAt":7},["ShallowReactive",2],{"docs-scrum\u002Fsprints\u002Fcreate":3,"docs-tabs-scrum\u002Fsprints\u002Fcreate":6},{"content":4,"lastmod":5},"## Create a sprint\n\n`POST \u002Fv1\u002Fscrum\u002Fsprints`\n\nCreates a sprint in a scrum project. The request body is flat, with no `fields` wrapper.\n\n## Request fields (body)\n\n| Field | Type | Required | Description |\n|------|-----|:-----:|---------|\n| `groupId` | number | yes | Scrum project ID. List of groups: [`GET \u002Fv1\u002Fworkgroups`](\u002Fdocs\u002Fentities\u002Fworkgroups\u002Flist) |\n| `name` | string | yes | Sprint name |\n| `dateStart` | string \\| number | yes | Sprint start: a date `2026-11-02` or a Unix timestamp |\n| `dateEnd` | string \\| number | yes | Sprint end: a date `2026-11-16` or a Unix timestamp |\n| `status` | string | yes | `planned`, `active` or `completed` |\n| `createdBy` | number | yes | ID of the sprint author. List: [`GET \u002Fv1\u002Fusers`](\u002Fdocs\u002Fentities\u002Fusers\u002Flist) |\n| `modifiedBy` | number | no | ID of the user who changed the sprint. If omitted, it equals `createdBy`. List: [`GET \u002Fv1\u002Fusers`](\u002Fdocs\u002Fentities\u002Fusers\u002Flist) |\n| `sort` | number | no | Sprint order within the project. Defaults to `0` |\n\nIf `name` or `createdBy` is missing, the sprint is not created and the response is `422 BITRIX_ERROR` with the message `Unable to add sprint`.\n\n## Examples\n\n### curl — personal key\n\n```bash\ncurl -X POST https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fscrum\u002Fsprints \\\n  -H \"X-Api-Key: YOUR_API_KEY\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"groupId\": 211,\n    \"name\": \"Sprint 12\",\n    \"dateStart\": \"2026-11-02\",\n    \"dateEnd\": \"2026-11-16\",\n    \"status\": \"planned\",\n    \"createdBy\": 1317\n  }'\n```\n\n### curl — OAuth application\n\n```bash\ncurl -X POST https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fscrum\u002Fsprints \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"groupId\": 211,\n    \"name\": \"Sprint 12\",\n    \"dateStart\": \"2026-11-02\",\n    \"dateEnd\": \"2026-11-16\",\n    \"status\": \"planned\",\n    \"createdBy\": 1317\n  }'\n```\n\n### JavaScript — personal key\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fscrum\u002Fsprints', {\n  method: 'POST',\n  headers: {\n    'X-Api-Key': 'YOUR_API_KEY',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({\n    groupId: 211,\n    name: 'Sprint 12',\n    dateStart: '2026-11-02',\n    dateEnd: '2026-11-16',\n    status: 'planned',\n    createdBy: 1317,\n  }),\n})\n\nconst { data } = await res.json()\nconsole.log('Sprint ID:', data.id)\n```\n\n### JavaScript — OAuth application\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fscrum\u002Fsprints', {\n  method: 'POST',\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({\n    groupId: 211,\n    name: 'Sprint 12',\n    dateStart: '2026-11-02',\n    dateEnd: '2026-11-16',\n    status: 'planned',\n    createdBy: 1317,\n  }),\n})\n\nconst { data } = await res.json()\nconsole.log('Sprint ID:', data.id)\n```\n\n## Response fields\n\n| Field | Type | Description |\n|------|-----|---------|\n| `success` | boolean | `true` on successful creation, HTTP status `201` |\n| `data` | object | The created sprint |\n| `data.id` | number | Sprint ID |\n| `data.groupId` | number | Scrum project ID |\n| `data.entityType` | string | Record type, `sprint` |\n| `data.name` | string | Sprint name |\n| `data.goal` | string | Sprint goal. An empty string until a goal is set |\n| `data.sort` | number | Sprint order within the project |\n| `data.createdBy` | number | ID of the sprint author |\n| `data.modifiedBy` | number | ID of the user who last changed the sprint |\n| `data.dateStart` | string | Sprint start in ISO 8601 format |\n| `data.dateEnd` | string | Sprint end in ISO 8601 format |\n| `data.status` | string | `planned`, `active` or `completed` |\n\n## Response example\n\n```json\n{\n  \"success\": true,\n  \"data\": {\n    \"id\": 53,\n    \"groupId\": 211,\n    \"entityType\": \"sprint\",\n    \"name\": \"Sprint 12\",\n    \"goal\": \"\",\n    \"sort\": 0,\n    \"createdBy\": 1317,\n    \"modifiedBy\": 1317,\n    \"dateStart\": \"2026-11-02T00:00:00+00:00\",\n    \"dateEnd\": \"2026-11-16T00:00:00+00:00\",\n    \"status\": \"planned\"\n  }\n}\n```\n\n## Error response example\n\n422 — `name` or `createdBy` is missing:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"BITRIX_ERROR\",\n    \"message\": \"Unable to add sprint\",\n    \"b24Code\": \"0\"\n  }\n}\n```\n\n## Errors\n\n| HTTP | Code | Description |\n|------|-----|---------|\n| 400 | `INVALID_PARAMS` | `groupId`, `dateStart`, `dateEnd` or `status` is missing, a field not listed in the table is passed, `status` is outside the allowed values, or an ID is not a positive integer |\n| 422 | `BITRIX_ERROR` | `Unable to add sprint` — `name` or `createdBy` is missing |\n| 422 | `BITRIX_ERROR` | `Access denied` — no group with this ID exists, it is not a scrum project, or there is no access to it |\n| 403 | `SCOPE_DENIED` | The key lacks the `task` scope |\n| 403 | `WRITE_BLOCKED_READONLY_KEY` | The key is read-only |\n| 401 | `TOKEN_MISSING` | The key has no tokens configured |\n\nThe full list of common API errors — [Errors](\u002Fdocs\u002Ferrors).\n\n## See also\n\n- [Update a sprint](\u002Fdocs\u002Fscrum\u002Fsprints\u002Fupdate)\n- [Delete a sprint](\u002Fdocs\u002Fscrum\u002Fsprints\u002Fdelete)\n- [Complete the active sprint](\u002Fdocs\u002Fscrum\u002Fsprints\u002Fcomplete)\n- [Sprints](\u002Fdocs\u002Fscrum\u002Fsprints)\n","2026-11-02",{},1794739602640]