Update a work item type

PATCH/api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-item-types/{type_id}/

Updates an existing work item type 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.

project_id:requiredstring

The unique identifier of the project.

type_id:requiredstring

The unique identifier for the work item type.

Body Parameters

name:optionalstring

Name of the work item type

description:optionalstring

Description of the work item type.

logo_props:optionalobject

Logo properties for the work item type.

is_epic:optionalboolean

Whether this work item type is an epic.

is_default:optionalboolean

Whether this is the default work item type.

is_active:optionalboolean

Whether this work item type is active.

level:optionalnumber

Hierarchical level of the work item type.

Update a work item type

curl -X PATCH \
  "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-item-types/{type_id}/" \
  -H "X-API-Key: $PLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "example-name",
  "description": "example-description",
  "logo_props": "example-logo_props",
  "is_epic": true,
  "is_default": true,
  "is_active": true,
  "level": 1
}'

import requests

response = requests.patch(
    "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-item-types/{type_id}/",
    headers={"X-API-Key": "your-api-key"},
    json={
  'name': 'example-name',
  'description': 'example-description',
  'logo_props': 'example-logo_props',
  'is_epic': true,
  'is_default': true,
  'is_active': true,
  'level': 1
}
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-item-types/{type_id}/",
  {
    method: "PATCH",
    headers: {
      "X-API-Key": "your-api-key",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
  "name": "example-name",
  "description": "example-description",
  "logo_props": "example-logo_props",
  "is_epic": true,
  "is_default": true,
  "is_active": true,
  "level": 1
})
  }
);
const data = await response.json();

Response200

{
  "id": "project-uuid",
  "name": "Project Name",
  "identifier": "PROJ",
  "description": "Project description",
  "created_at": "2024-01-01T00:00:00Z"
}