Create version
create_versionCreate a version (release, milestone or sprint) in a project to plan sprints or releases before assigning work packages. Duplicate names or invalid date ranges return named violations instead of opaque errors.
Instructions
Create a version (release, milestone or sprint) inside a project.
Use it to open a new sprint or plan a release before assigning work packages to it.
The call goes through POST /versions/form first, so a duplicate name or an
impossible date range comes back as violations naming the attribute instead of an
opaque rejection.
Returns the created version {id, name, project, status, start_date, end_date, description, sharing, source, created_at, updated_at}. The id is what
update_work_package(version=...) and update_version consume.
Pitfalls: end_date is the version's finish date and is written to the API's
endDate field — passing a date here always lands (an older client dropped it
silently). Creating versions needs the 'manage versions' permission in the project,
so a 403 is about the account, not the payload. Versions are per project: sharing is
the only way another project sees this one.
Cross-references: list_versions for what already exists (and for the ids);
update_version to change dates or close it later; list_projects for the
project id.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"project_id": "<project_id>",
"name": "<name>"
},
"name": "create_version"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Version name, e.g. 'Sprint 12' or 'Release 2.1'. Must be unique inside the defining project. | |
| status | No | open (default upstream), locked or closed. Locked and closed versions cannot receive new work packages, so create with 'open' unless you are recording history. | |
| sharing | No | Which other projects may use this version: none (default), descendants, hierarchy, tree or system (the whole instance). Use 'descendants' for a release shared with subprojects. | |
| end_date | No | ISO date (YYYY-MM-DD) the version finishes — this is the version's due date, sent as the API's 'endDate'. Omit for none. | |
| project_id | Yes | Numeric id or identifier of the project that will DEFINE the version. Sharing decides which other projects can use it; the defining project cannot be changed afterwards. | |
| start_date | No | ISO date (YYYY-MM-DD) the version starts. Omit for none. | |
| description | No | Markdown description of the version's scope. Omit for none. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | ||
| name | No | ||
| source | No | ||
| status | No | ||
| project | No | ||
| sharing | No | ||
| end_date | No | ||
| created_at | No | ||
| start_date | No | ||
| updated_at | No | ||
| description | No |