Project workspace

create-sprint-tool

Create a sprint on a project. The sprint starts in the upcoming state.

Creates a new sprint on a project. The sprint is created in the upcoming state (is_active=false, no started_at, no completed_at). Use start-sprint-tool to activate it later.

Inputs

NameTypeRequiredDescription
project_idintegeryesProject the sprint belongs to.
namestringyesSprint name (max 255 characters).
descriptionstringnoOptional description / sprint goal.
start_datestring (Y-m-d)noPlanned start date.
end_datestring (Y-m-d)noPlanned end date. Must be on or after start_date.

Permissions

  • project_management::manage_sprints (entry permission).
  • The user must also be allowed to manage the Sprint class by SprintPolicy.

Example

{
  "project_id": 3,
  "name": "Sprint 24",
  "description": "Stripe migration cleanup",
  "start_date": "2026-06-01",
  "end_date": "2026-06-15"
}

Response

Returns the new sprint:

{
  "id": 7,
  "name": "Sprint 24",
  "description": "Stripe migration cleanup",
  "state": "upcoming",
  "is_active": false,
  "start_date": "2026-06-01",
  "end_date": "2026-06-15",
  "started_at": null,
  "completed_at": null,
  "order": 24,
  "project_id": 3
}

Errors

  • An unknown project_id returns a validation error.
  • An end_date before start_date returns a validation error.
  • A caller without project_management::manage_sprints receives an authorization error.

On this page