[{"data":1,"prerenderedAt":7},["ShallowReactive",2],{"docs-scrum\u002Fsprints\u002Fupdate":3,"docs-tabs-scrum\u002Fsprints\u002Fupdate":6},{"content":4,"lastmod":5},"## Update a sprint\n\n`PATCH \u002Fv1\u002Fscrum\u002Fsprints\u002F:id`\n\nChanges the name, dates, order or status of a sprint. The request body is flat, with no `fields` wrapper; pass only the fields you change.\n\n## Parameters\n\n| Parameter | Type | Required | Description |\n|----------|-----|:-----:|---------|\n| `id` (path) | number | yes | Sprint ID. Obtain it from the [list of sprints](\u002Fdocs\u002Fscrum\u002Fsprints\u002Flist) or the [active sprint](\u002Fdocs\u002Fscrum\u002Fsprints\u002Factive) |\n\n## Request fields (body)\n\nAt least one field is required.\n\n| Field | Type | Description |\n|------|-----|---------|\n| `name` | string | Sprint name |\n| `dateStart` | string \\| number | Sprint start: a date `2026-11-02` or a Unix timestamp |\n| `dateEnd` | string \\| number | Sprint end: a date `2026-11-16` or a Unix timestamp |\n| `status` | string | `planned`, `active` or `completed` |\n| `sort` | number | Sprint order within the project |\n| `groupId` | number | Scrum project ID. List of groups: [`GET \u002Fv1\u002Fworkgroups`](\u002Fdocs\u002Fentities\u002Fworkgroups\u002Flist) |\n| `createdBy` | number | ID of the sprint author. List: [`GET \u002Fv1\u002Fusers`](\u002Fdocs\u002Fentities\u002Fusers\u002Flist) |\n| `modifiedBy` | number | ID of the user who changed the sprint. List: [`GET \u002Fv1\u002Fusers`](\u002Fdocs\u002Fentities\u002Fusers\u002Flist) |\n\n## Examples\n\n### curl — personal key\n\n```bash\ncurl -X PATCH https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fscrum\u002Fsprints\u002F45 \\\n  -H \"X-Api-Key: YOUR_API_KEY\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{ \"name\": \"Sprint 11\", \"dateEnd\": \"2026-11-16\" }'\n```\n\n### curl — OAuth application\n\n```bash\ncurl -X PATCH https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fscrum\u002Fsprints\u002F45 \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{ \"name\": \"Sprint 11\", \"dateEnd\": \"2026-11-16\" }'\n```\n\n### JavaScript — personal key\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fscrum\u002Fsprints\u002F45', {\n  method: 'PATCH',\n  headers: {\n    'X-Api-Key': 'YOUR_API_KEY',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({ name: 'Sprint 11', dateEnd: '2026-11-16' }),\n})\n\nconst { data: sprint } = await res.json()\nconsole.log(sprint.name, sprint.dateEnd)\n```\n\n### JavaScript — OAuth application\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fscrum\u002Fsprints\u002F45', {\n  method: 'PATCH',\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({ name: 'Sprint 11', dateEnd: '2026-11-16' }),\n})\n\nconst { data: sprint } = await res.json()\nconsole.log(sprint.name, sprint.dateEnd)\n```\n\n## Response fields\n\n| Field | Type | Description |\n|------|-----|---------|\n| `success` | boolean | `true` on successful update |\n| `data` | object | The sprint after the update |\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 |\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\": 45,\n    \"groupId\": 211,\n    \"entityType\": \"sprint\",\n    \"name\": \"Sprint 11\",\n    \"goal\": \"\",\n    \"sort\": 1,\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\n404 — no sprint with this ID exists:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"ENTITY_NOT_FOUND\",\n    \"message\": \"Sprint not found\"\n  }\n}\n```\n\n## Errors\n\n| HTTP | Code | Description |\n|------|-----|---------|\n| 400 | `INVALID_PARAMS` | Empty body, a field outside the table, `status` outside the allowed values, or an ID that is not a positive integer |\n| 404 | `ENTITY_NOT_FOUND` | No sprint with this `id` exists |\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## Known specifics\n\n- **Changing the status skips the start checks.** `status: \"active\"` makes a planned sprint active even when it has no tasks. The [regular start](\u002Fdocs\u002Fscrum\u002Fsprints#starting-a-sprint) refuses such a sprint.\n\n## See also\n\n- [Create a sprint](\u002Fdocs\u002Fscrum\u002Fsprints\u002Fcreate)\n- [Get a sprint](\u002Fdocs\u002Fscrum\u002Fsprints\u002Fget)\n- [Delete a sprint](\u002Fdocs\u002Fscrum\u002Fsprints\u002Fdelete)\n- [Sprints](\u002Fdocs\u002Fscrum\u002Fsprints)\n","2026-11-02",{},1794739603183]