ConnectCloud Developers

Change a milestone (tenant:forge:write and, as a member, at least developer)

PATCH /api/forge/v1/projects/{key}/milestones/{id}

Module: Forge · operationId: patchForgeMilestone · Tag: Milestones · Auth: access token (Authorization: Bearer <accessToken>)

Same permission as creating. version is required (409 version_conflict); null clears dueOn and, for both fields together, the release. Nothing changed writes no event. Writes forge.milestone.saved.

Parameters

Name In Type Required Description
key path string yes Project key (e.g. APP)
id path string (uuid) yes

Request body

application/json (required)

  • description (string): Description (Markdown) (max length 20000)
  • dueOn (string (date), nullable): Due date; null clears it
  • releaseProvider (string): Provider of releaseRepo; needed only when the project links the same name at several providers (400 releaseProvider otherwise)
  • releaseRepo (string, nullable): Full name of a repository of the project (owner/name, GitLab: group/subgroup/project)
  • releaseTag (string, nullable): Git tag of the release (set together with releaseRepo); null clears it (max length 128)
  • title (string): Title (max length 120)
  • version (integer): PATCH: the version the change is based on

Example:

{
  "dueOn": "2026-12-02",
  "releaseRepo": "mbcomdev/demo-app",
  "releaseTag": "v1.1.0",
  "version": 2
}

Responses

  • 200 Changed (application/json)
  • 400 Error (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 open
  • createdAt (string (date-time), required): When it was created
  • description (string, required): Markdown
  • dueOn (string (date), nullable, required): Due date; null when none
  • id (string (uuid), required): Milestone id
  • position (integer, required): Order of the milestones
  • releaseProvider (string, required): Provider of releaseRepo (github without a release)
  • releaseRepo (string, nullable, required): Full name of a repository of the project
  • releaseTag (string, nullable, required): Git tag of the release in releaseRepo
  • state (string, required): open or closed (one of open, closed)
  • title (string, required): Title
  • updatedAt (string (date-time), required): Last change
  • version (integer, required): Optimistic-locking version; send it with PATCH
  • progress (MilestoneProgress, required)
    • byCategory (object, required): Items per status category
      • active (integer, required): Items in progress
      • cancelled (integer, required): Items cancelled
      • done (integer, required): Items done
      • on_hold (integer, required): Items on hold
      • todo (integer, required): Items in todo
      • triage (integer, required): Items in triage
    • estimate (object, required): Sums of the estimates
      • done (number, required): Sum of the estimates of items in a done status
      • total (number, required): Sum of the estimates without cancelled items
    • total (integer, required): Items in the milestone

Example 200 answer:

{
  "closedAt": null,
  "createdAt": "2026-09-30T13:00:00Z",
  "description": "Kunden sehen ihre Tickets mit Filtern, Seitenwechseln und einem verständlichen leeren Zustand.",
  "dueOn": "2026-11-25",
  "id": "e0a1b2c3-d4e5-4f6a-8b23-0e1f2a3b4c02",
  "position": 1,
  "progress": {
    "byCategory": {
      "active": 2,
      "cancelled": 0,
      "done": 5,
      "on_hold": 0,
      "todo": 2,
      "triage": 0
    },
    "estimate": {
      "done": 12,
      "total": 25
    },
    "total": 9
  },
  "releaseProvider": "github",
  "releaseRepo": null,
  "releaseTag": null,
  "state": "open",
  "title": "Version 1.1 – Ticketübersicht",
  "updatedAt": "2026-10-21T10:15:00Z",
  "version": 2
}

Example request

curl -X PATCH 'https://api.mbcom.cloud/api/forge/v1/projects/string/milestones/3f2b8c1e-7d4a-4e9b-9c2a-5b1d6e8f0a12' \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  --data '{"dueOn":"2026-12-02","releaseRepo":"mbcomdev/demo-app","releaseTag":"v1.1.0","version":2}'

View as Markdown · Interactive reference · OpenAPI