ConnectCloud Developers

Write a section of an item (tenant:forge:write and, as a member, at least developer)

PUT /api/forge/v1/projects/{key}/items/{number}/sections/{section}

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

Same permission as changing an item. Integrations (API keys) and the assistant may write every section; a section not defined for the item's type is 404. version is the version the text was based on (0 for a new section; else 409 version_conflict). Every write is a revision. Writes forge.item.section_updated.

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)
section path string yes Section definition key (e.g. plan)

Request body

application/json (required)

  • body (string, required): New content (Markdown; checklist: a task list) (max length 100000)
  • version (integer, required): The version the text was based on (0 for a section never written); 409 version_conflict otherwise

Example:

{
  "body": "Die Komponente bekommt ihre Optionen über Props und meldet Änderungen als Ereignis. Der Zeitraum nutzt\nden Datumsdialog des Betriebssystems, damit wir keine eigene Kalender-Ansicht bauen müssen.",
  "version": 1
}

Responses

  • 200 Written (application/json)
  • 400 Error (application/json)
  • 403 Error (application/json)
  • 404 Error (application/json)
  • 409 Error (application/json)

Fields of the 200 answer:

  • body (string, required): Markdown (checklist: a task list)
  • key (string, required): Section key
  • kind (string, required): markdown or checklist (one of markdown, checklist)
  • label (string, required): Display label
  • placement (string, required): Where the portal shows it: a tab or the side column (one of tab, aside)
  • version (integer, required): 0 = never written
  • updatedAt (string (date-time), nullable): When the current version was written; null when never written
  • updatedByKind (string): Kind of actor who wrote it
  • updatedByName (string): Name of who wrote it
  • updatedByRef (string): E-mail (or actor ref) of who wrote the current version

Example 200 answer:

{
  "body": "Die Komponente bekommt ihre Optionen über Props und meldet Änderungen als Ereignis. Der Zeitraum nutzt\nden Datumsdialog des Betriebssystems, damit wir keine eigene Kalender-Ansicht bauen müssen.",
  "key": "plan",
  "kind": "markdown",
  "label": "Plan",
  "placement": "tab",
  "updatedAt": "2026-11-18T09:40:00Z",
  "updatedByKind": "person",
  "updatedByName": "Marie Wagner",
  "updatedByRef": "marie.wagner@muster-it.example",
  "version": 2
}

Example request

curl -X PUT 'https://api.mbcom.cloud/api/forge/v1/projects/string/items/1/sections/string' \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  --data '{"body":"Die Komponente bekommt ihre Optionen über Props und meldet Änderungen als Ereignis. Der Zeitraum nutzt\nden Datumsdialog des Betriebssystems, damit wir keine eigene Kalender-Ansicht bauen müssen.","version":1}'

View as Markdown · Interactive reference · OpenAPI