Update project label

PATCH/api/v1/workspaces/{slug}/project-labels/{pk}/

Partially update an existing project label's properties like name, color, or description.

Path Parameters

pk:requiredstring

Project Label ID

slug:requiredstring

Workspace slug

Body Parameters

name:optionalstring

Name.

description:optionalstring

Description.

color:optionalstring

Color.

sort_order:optionalnumber

Sort order.

Scopes

projects.labels:write

Update project label

curl -X PATCH \
  "https://api.plane.so/api/v1/workspaces/my-workspace/project-labels/550e8400-e29b-41d4-a716-446655440000/" \
  -H "X-API-Key: $PLANE_API_KEY" \
  # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Example Name",
  "color": "#00ff00",
  "description": "Example description"
}'

import requests

response = requests.patch(
    "https://api.plane.so/api/v1/workspaces/my-workspace/project-labels/550e8400-e29b-41d4-a716-446655440000/",
    headers={"X-API-Key": "your-api-key"},
    json={
      "name": "Example Name",
      "color": "#00ff00",
      "description": "Example description"
    }
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v1/workspaces/my-workspace/project-labels/550e8400-e29b-41d4-a716-446655440000/",
  {
    method: "PATCH",
    headers: {
      "X-API-Key": "your-api-key",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      name: "Example Name",
      color: "#00ff00",
      description: "Example description",
    }),
  }
);
const data = await response.json();

Response200

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Example Name",
  "color": "#f39c12",
  "description": "Example description",
  "sort_order": 65535,
  "workspace": "550e8400-e29b-41d4-a716-446655440000",
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z",
  "created_by": "550e8400-e29b-41d4-a716-446655440000",
  "updated_by": "550e8400-e29b-41d4-a716-446655440000"
}