---
title: "Update a sprint"
method: PATCH
path: "/api/workspaces/{workspaceId}/projects/{projectId}/sprints/{sprintId}"
tags: ["Sprints"]
---

# Update a sprint

`PATCH /api/workspaces/{workspaceId}/projects/{projectId}/sprints/{sprintId}`

## Request

- Base URL: `https://hiveship.app/api`
- URL: `https://hiveship.app/api/api/workspaces/{workspaceId}/projects/{projectId}/sprints/{sprintId}`
- Auth: API key in cookie `hiveship_access`

## Path parameters

- `workspaceId` string, required
- `projectId` string, required
- `sprintId` string, required

## Request body

- object
  - `name` string
  - `goal` string
  - `status` 'PLANNING' | 'ACTIVE' | 'COMPLETED'
  - `startDate` string, date-time
  - `endDate` string, date-time

## Response `200`

Sprint updated

- object
  - `success` boolean, required
  - `data` object, required
    - `id` string, cuid, required
    - `name` string, required
    - `goal` string, nullable, required
    - `status` 'PLANNING' | 'ACTIVE' | 'COMPLETED', required
    - `startDate` string, date-time, nullable, required
    - `endDate` string, date-time, nullable, required
    - `issueCount` integer, required
    - `completedIssueCount` integer, required
    - `totalPoints` integer, required
    - `completedPoints` integer, required

## Other responses

- `404`: Sprint not found

---

[API](https://skmtc.dev/hiveship/apis/hiveship-api.md) · [All operations](https://skmtc.dev/hiveship/apis/hiveship-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hiveship/apis/hiveship-api/revisions/73d3e26544e4?raw)