Update a sprint

Update fields on a sprint.

Path Parameters

Name	Type	Required	Description
`sprintId`	string	Required	Sprint ID.

Request Body

Property	Type	Required	Description
`name`	string	Optional	Sprint name.
`goal`	string	Optional	Sprint goal.
`status`	string	Optional	Status.
`startDate`	string	Optional	ISO 8601 start date.
`endDate`	string	Optional	ISO 8601 end date.

PATCHExample request

curl

curl -X PATCH "https://www.pxb.app/api/public/v1/sprints/{sprintId}" \
  -H "X-Organization-Id: your_org_id" \
  -H "X-API-Key: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "COMPLETED"
  }'

200Example response

json

{
  "message": "Sprint updated successfully!",
  "content": {
    "sprint": {
      "id": "spr_1"
    }
  }
}