Create a release label
POST/api/v2/workspaces/{slug}/releases/labels/
Release labels are the workspace-level label catalog for releases. Create a release label.
Path Parameters
slug:requiredstringThe workspace slug. It appears in your Plane URLs — in https://app.plane.so/my-team/projects/, the slug is my-team.
Body Parameters
name:requiredstringDisplay name.
Maximum 255 characters.
color:optionalstringHex color used wherever this is rendered, for example #3f76ff.
Maximum 255 characters.
sort_order:optionalintegerManual ordering weight. Lower sorts first.
Response shaping
fields:optionalstringComma-separated list of fields to return. Unrequested keys are omitted, not returned as null. id always comes back. Pass all for every requestable field. An unknown name is a 400. See Sparse fields.
Requestable here: color, created_at, created_by_id, id, name, sort_order.
Scopes
releases.labels:write
Errors
| Status | Code | Cause |
|---|---|---|
400 | invalid_request | The request body or a query parameter failed validation. |
401 | unauthorized | Missing or invalid credentials. |
402 | payment_required | The feature this endpoint belongs to isn't enabled on your plan or is switched off. |
403 | forbidden | Your role or token scope doesn't allow this. |
404 | not_found | No such resource, or it's outside your tenant. |
406 | not_acceptable | The Accept header asks for a representation the API can't produce. |
409 | conflict | A business rule blocks the write — see the notes above. |
413 | payload_too_large | The request body is over the size limit. |
415 | unsupported_media_type | The Content-Type isn't one this endpoint accepts. |
429 | rate_limited | Throttled. Honor the Retry-After header before retrying. |
Create a release label
bash
curl -X POST \
"https://api.plane.so/api/v2/workspaces/my-team/releases/labels/" \
-H "X-Api-Key: $PLANE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Example name",
"color": "#3f76ff",
"sort_order": 65535
}'python
import requests
response = requests.post(
"https://api.plane.so/api/v2/workspaces/my-team/releases/labels/",
headers={"X-Api-Key": "your-api-key"},
json={
"name": "Example name",
"color": "#3f76ff",
"sort_order": 65535
},
)
print(response.json())javascript
const response = await fetch("https://api.plane.so/api/v2/workspaces/my-team/releases/labels/", {
method: "POST",
headers: {
"X-Api-Key": "your-api-key",
"Content-Type": "application/json",
},
body: JSON.stringify({
name: "Example name",
color: "#3f76ff",
sort_order: 65535,
}),
});
const data = await response.json();Response201
json
{
"color": "#3f76ff",
"created_at": "2026-01-14T09:22:41.478363Z",
"created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
"id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
"name": "Example name",
"sort_order": 65535
}
