Close a milestone (tenant:forge:write and, as a member, at least developer)
POST /api/forge/v1/projects/{key}/milestones/{id}/close
Module: Forge · operationId: closeForgeMilestone · Tag: Milestones · Auth: access token (Authorization: Bearer <accessToken>)
Same permission as creating. Closing is allowed with open items (they stay in the milestone, no automatic move) and the answer's progress counts them; a closed milestone takes no new items. Already closed changes nothing. Writes forge.milestone.closed.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
key |
path | string | yes | Project key (e.g. APP) |
id |
path | string (uuid) | yes |
Responses
- 200 Closed (
application/json) - 403 Error (
application/json) - 404 Error (
application/json) - 409 Error (
application/json)
Fields of the 200 answer:
closedAt(string (date-time), nullable, required): When it was closed; null while opencreatedAt(string (date-time), required): When it was createddescription(string, required): MarkdowndueOn(string (date), nullable, required): Due date; null when noneid(string (uuid), required): Milestone idposition(integer, required): Order of the milestonesreleaseProvider(string, required): Provider of releaseRepo (github without a release)releaseRepo(string, nullable, required): Full name of a repository of the projectreleaseTag(string, nullable, required): Git tag of the release in releaseRepostate(string, required): open or closed (one ofopen,closed)title(string, required): TitleupdatedAt(string (date-time), required): Last changeversion(integer, required): Optimistic-locking version; send it with PATCHprogress(MilestoneProgress, required)byCategory(object, required): Items per status categoryactive(integer, required): Items in progresscancelled(integer, required): Items cancelleddone(integer, required): Items doneon_hold(integer, required): Items on holdtodo(integer, required): Items in todotriage(integer, required): Items in triage
estimate(object, required): Sums of the estimatesdone(number, required): Sum of the estimates of items in a done statustotal(number, required): Sum of the estimates without cancelled items
total(integer, required): Items in the milestone
Example 200 answer:
{
"closedAt": "2026-11-04T10:00:00Z",
"createdAt": "2026-09-23T10:00:00Z",
"description": "Erste Version im App Store und bei Google Play mit Anmeldung per Passkey.",
"dueOn": "2026-11-04",
"id": "e0a1b2c3-d4e5-4f6a-8b23-0e1f2a3b4c01",
"position": 0,
"progress": {
"byCategory": {
"active": 0,
"cancelled": 1,
"done": 8,
"on_hold": 0,
"todo": 0,
"triage": 0
},
"estimate": {
"done": 28,
"total": 28
},
"total": 9
},
"releaseProvider": "github",
"releaseRepo": "mbcomdev/demo-app",
"releaseTag": "v1.0.0",
"state": "closed",
"title": "Version 1.0 – Anmeldung",
"updatedAt": "2026-11-04T10:00:00Z",
"version": 3
}
Example request
curl -X POST 'https://api.mbcom.cloud/api/forge/v1/projects/string/milestones/3f2b8c1e-7d4a-4e9b-9c2a-5b1d6e8f0a12/close' \
-H "Authorization: Bearer $ACCESS_TOKEN"