Update sprint
PATCH
/v1/tasks/sprints/{sprintId}How to call this endpoint
Every ACP API request uses bearer authentication. The examples here show the actual request path, auth header, and body shape that the platform expects.
Path, query, and header parameters
These parameters control which ACP object the endpoint acts on and how the request is processed.
Path parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
| sprintId | path | string | Yes | Sprint ID |
Query parameters
None.
Body schema
Content type: application/json · Optional
| Field | Type | Required | Description |
|---|---|---|---|
| projectId | string | No | Project ID. |
| name | string | No | Human-readable name. |
| goal | string | No | — |
| status | planned | active | completed | No | Current lifecycle status. |
| startAt | string | No | — |
| endAt | string | No | — |
| sortOrder | number | No | — |
| metadata | object | No | Free-form metadata object. |
What the API returns
Each response code below includes the documented payload shape for the ACP API.
200Sprint updatedapplication/json
| Field | Type | Required | Description |
|---|---|---|---|
| sprint | object | No | — |
| sprint.id | string | No | Unique identifier. |
| sprint.userId | string | No | User ID. |
| sprint.projectId | string | No | Project ID. |
| sprint.name | string | No | Human-readable name. |
| sprint.goal | string | No | — |
| sprint.status | planned | active | completed | No | Current lifecycle status. |
| sprint.startAt | string | No | — |
| sprint.endAt | string | No | — |
| sprint.sortOrder | number | No | — |
| sprint.metadata | object | No | Free-form metadata object. |
| sprint.createdAt | string | No | ISO 8601 timestamp. |
| sprint.updatedAt | string | No | ISO 8601 timestamp. |