Update an initiative label

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

Updates an existing initiative label by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path Parameters

workspace_slug:requiredstring

The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL https://app.plane.so/my-team/projects/, the workspace slug is my-team.

label_id:requiredstring

The unique identifier for the initiative label.

Body Parameters

name:optionalstring

Name of the initiative label.

description:optionalstring

Description of the initiative label.

color:optionalstring

Hex color code for the initiative label (e.g., "#eb5757").

sort_order:optionalnumber

Sort order for display purposes.

Update an initiative label

curl -X PATCH \
  "https://api.plane.so/api/v1/workspaces/my-workspace/initiatives/labels/label-uuid/" \
  -H "X-API-Key: $PLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "example-name",
  "description": "example-description",
  "color": "example-color",
  "sort_order": 1
}'

import requests

response = requests.patch(
    "https://api.plane.so/api/v1/workspaces/my-workspace/initiatives/labels/label-uuid/",
    headers={"X-API-Key": "your-api-key"},
    json={
  'name': 'example-name',
  'description': 'example-description',
  'color': 'example-color',
  'sort_order': 1
}
)
print(response.json())

const response = await fetch('https://api.plane.so/api/v1/workspaces/my-workspace/initiatives/labels/label-uuid/', {
  method: 'PATCH',
  headers: {
    'X-API-Key': 'your-api-key',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'example-name',
    description: 'example-description',
    color: 'example-color',
    sort_order: 1,
  }),
});
const data = await response.json();

Response200

{
  "id": "resource-uuid",
  "created_at": "2024-01-01T00:00:00Z"
}