ConnectCloud Developers

Edit one's own comment (its author, with comment rights: tenant:forge:write, or any member role in the project)

PATCH /api/forge/v1/projects/{key}/items/{number}/comments/{id}

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

Requires the permission to comment; only the author edits. Writes forge.item.comment_edited.

Parameters

Name In Type Required Description
key path string yes Project key (e.g. APP)
number path integer yes Item number in the project (12 of APP-12)
id path string (uuid) yes

Request body

application/json (required)

  • body (string, required): Comment text (Markdown) (max length 20000)

Example:

{
  "body": "Zwei Anmerkungen im Pull Request, vor allem der Fokus beim Schließen des Bottom-Sheets. Sonst sieht es gut aus."
}

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:

  • authorKind (string, required): Kind of actor that wrote it (one of person, integration, assistant, system, automation)
  • authorName (string, required): Display name of the author
  • authorRef (string, required): E-mail (or actor ref) of the author
  • body (string, required): Markdown
  • createdAt (string (date-time), required): When the comment was written
  • id (string (uuid), required): Comment id
  • itemId (string (uuid), required): The item commented on
  • deletedAt (string (date-time), nullable): When it was deleted (the body is then empty); null otherwise
  • editedAt (string (date-time), nullable): Last edit; null when never edited
  • originRef (string): Comments imported by a conversion: the source item, e.g. #123
  • originVisibility (string): Comments imported by a conversion: the visibility on the source side (one of public, internal)

Example 200 answer:

{
  "authorKind": "person",
  "authorName": "Emma Maier",
  "authorRef": "emma.maier@muster-it.example",
  "body": "Zwei Anmerkungen im Pull Request, vor allem der Fokus beim Schließen des Bottom-Sheets.",
  "createdAt": "2026-11-17T09:20:00Z",
  "deletedAt": null,
  "editedAt": null,
  "id": "4a5b6c7d-8e9f-4a0b-9c1d-3e4f5a6b7c01",
  "itemId": "2a3b4c5d-6e7f-4a8b-9c0d-1e2f3a4b5c06"
}

Example request

curl -X PATCH 'https://api.mbcom.cloud/api/forge/v1/projects/string/items/1/comments/3f2b8c1e-7d4a-4e9b-9c2a-5b1d6e8f0a12' \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  --data '{"body":"Zwei Anmerkungen im Pull Request, vor allem der Fokus beim Schließen des Bottom-Sheets. Sonst sieht es gut aus."}'

View as Markdown · Interactive reference · OpenAPI