Create a status (tenant:forge:write and maintainer, or tenant:forge:admin)
POST /api/forge/v1/projects/{key}/statuses
Module: Forge · operationId: createForgeStatus · Tag: Configuration · Auth: access token (Authorization: Bearer <accessToken>)
Requires tenant:forge:admin, or tenant:forge:write and project role maintainer or admin. Writes forge.config.updated.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
key |
path | string | yes | Project key (e.g. APP) |
Request body
application/json (required)
category(string): Status category (one oftriage,todo,active,on_hold,done,cancelled)color(string): Color token (neutral, primary, …) or #rrggbbisDefault(boolean): true makes it the default status (moves the default); cannot be unsetkey(string): Create: status key; fixed afterwardsname(string): Display name (max length 60)version(integer): PATCH: the version the change is based on
Example:
{
"category": "on_hold",
"color": "neutral",
"key": "wartet",
"name": "Wartet auf Rückmeldung"
}
Responses
- 201 Created (
application/json) - 400 Error (
application/json) - 403 Error (
application/json) - 404 Error (
application/json) - 409 Error (
application/json)
Fields of the 201 answer:
category(string, required): Status category (the group the status belongs to) (one oftriage,todo,active,on_hold,done,cancelled)color(string, required): Color token (neutral, primary, …) or #rrggbbid(string (uuid), required): Status idisDefault(boolean, required): Where new items start; exactly one, in triage or todokey(string, required): Status key; never changesname(string, required): Display nameposition(integer, required): Order in the configurationversion(integer, required): Optimistic-locking version; send it with PATCH
Example 201 answer:
{
"category": "active",
"color": "warning",
"id": "5d1e2f3a-4b5c-4d6e-8f7a-1b2c3d4e5f04",
"isDefault": false,
"key": "review",
"name": "Review",
"position": 3,
"version": 1
}
Example request
curl -X POST 'https://api.mbcom.cloud/api/forge/v1/projects/string/statuses' \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H 'Content-Type: application/json' \
--data '{"category":"on_hold","color":"neutral","key":"wartet","name":"Wartet auf Rückmeldung"}'