Change a label (tenant:forge:write and maintainer, or tenant:forge:admin)
PATCH /api/forge/v1/projects/{key}/labels/{id}
Module: Forge · operationId: patchForgeLabel · Tag: Configuration · Auth: access token (Authorization: Bearer <accessToken>)
Same permission as creating. version is required (409 version_conflict); keys never change.
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)
color(string): Color token (neutral, primary, …) or #rrggbbdescription(string): Description (max length 500)name(string): Name, unique per project ignoring case;scope::valuemakes it exclusive within the scope (max length 60)version(integer): PATCH: the version the change is based on
Example:
{
"description": "Android-App (Kotlin)",
"version": 1
}
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:
color(string, required): Color token (neutral, primary, …) or #rrggbbdescription(string, required): Descriptionid(string (uuid), required): Label idname(string, required): scope::value makes it exclusive within the scopeversion(integer, required): Optimistic-locking version; send it with PATCH
Example 200 answer:
{
"color": "success",
"description": "",
"id": "8a4b5c6d-7e8f-4a9b-8cad-4e5f6a7b8c05",
"name": "plattform::android",
"version": 1
}
Example request
curl -X PATCH 'https://api.mbcom.cloud/api/forge/v1/projects/string/labels/3f2b8c1e-7d4a-4e9b-9c2a-5b1d6e8f0a12' \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H 'Content-Type: application/json' \
--data '{"description":"Android-App (Kotlin)","version":1}'