ConnectCloud Developers

Save a project's configuration as a tenant template (tenant:forge:admin)

POST /api/forge/v1/projects/{key}/save-as-template

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

Requires tenant:forge:admin. 409 key_taken for a used or built-in key.

Parameters

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

Request body

application/json (required)

  • key (string, required)
  • name (string, required): (max length 120)
  • description (string): (max length 2000)

Example:

{
  "description": "Scrum mit den Bereichs- und Plattform-Labels der Kundenportal-App.",
  "key": "muster-app",
  "name": "Muster-App-Projekt"
}

Responses

  • 201 Saved (application/json)
  • 400 Error (application/json)
  • 403 Error (application/json)
  • 404 Error (application/json)
  • 409 Error (application/json)

Fields of the 201 answer:

  • builtIn (boolean, required): A built-in template (chosen by key; no id)
  • description (string, required): Description
  • key (string, required): Template key (built-in) or the saved key
  • name (string, required): Display name
  • summary (object, required): Number of rows per configuration collection
  • createdAt (string (date-time)): Saved templates: when it was saved
  • createdBy (string): Saved templates: e-mail of who saved it
  • id (string (uuid)): Saved templates only

Example 201 answer:

{
  "builtIn": false,
  "createdAt": "2026-11-12T15:30:00Z",
  "createdBy": "emma.maier@muster-it.example",
  "description": "Scrum mit den Bereichs- und Plattform-Labels der Kundenportal-App.",
  "id": "2e4f6a8b-0c1d-4e3f-9a5b-7c9d1e3f5a01",
  "key": "muster-app",
  "name": "Muster-App-Projekt",
  "summary": {
    "automations": 3,
    "customFields": 1,
    "itemTemplates": 1,
    "itemTypes": 5,
    "labels": 12,
    "sectionDefs": 3,
    "statuses": 6,
    "workflows": 1
  }
}

Example request

curl -X POST 'https://api.mbcom.cloud/api/forge/v1/projects/string/save-as-template' \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  --data '{"description":"Scrum mit den Bereichs- und Plattform-Labels der Kundenportal-App.","key":"muster-app","name":"Muster-App-Projekt"}'

View as Markdown · Interactive reference · OpenAPI