Update a release label

PATCH/api/v1/workspaces/{workspace_slug}/releases/labels/{label_id}/

Updates an existing release label. Parameters you don't send are left unchanged. The label name must remain unique per workspace (or per project), otherwise the request fails with a 400 RELEASE_LABEL_NAME_ALREADY_EXISTS error.

Path parameters

workspace_slug:requiredstring

The workspace slug. It appears in your Plane URLs. In https://app.plane.so/my-team/projects/, the slug is my-team.

label_id:requiredstring

The unique identifier for the release label.

Body parameters

name:optionalstring

Name of the release label.

color:optionalstring

Hex color code for the label.

sort_order:optionalnumber

Sort order for the label.

Scopes

releases.labels:write

Update a release label

curl -X PATCH \
  "https://api.plane.so/api/v1/workspaces/my-workspace/releases/labels/f6a7b8c9-d0e1-2345-fabc-678901234567/" \
  -H "X-API-Key: $PLANE_API_KEY" \
  # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "color": "#DE350B",
  "sort_order": 5
}'

import requests

response = requests.patch(
    "https://api.plane.so/api/v1/workspaces/my-workspace/releases/labels/f6a7b8c9-d0e1-2345-fabc-678901234567/",
    headers={"X-API-Key": "your-api-key"},
    json={
  'color': '#DE350B',
  'sort_order': 5
}
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v1/workspaces/my-workspace/releases/labels/f6a7b8c9-d0e1-2345-fabc-678901234567/",
  {
    method: "PATCH",
    headers: {
      "X-API-Key": "your-api-key",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      color: "#DE350B",
      sort_order: 5,
    }),
  },
);
const data = await response.json();

Response200

{
  "id": "f6a7b8c9-d0e1-2345-fabc-678901234567",
  "name": "Breaking change",
  "color": "#DE350B",
  "sort_order": 5,
  "workspace": "cd4ab5a2-1a5f-4516-a6c6-8da1a9fa5be4",
  "project": null
}