Update a work item type

Updates an existing work item type by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

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

Update a work item type

cURL

curl --request PATCH \
  --url https://api.plane.so/api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-item-types/{type_id}/ \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "logo_props": {},
  "is_epic": true,
  "is_default": true,
  "is_active": true,
  "level": 123
}
'

Path parameters

workspace_slug · string · required

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 · string · required

The unique identifier of the project.

type_id · string · required

The unique identifier for the work item type.

Body parameters

name · string

Name of the work item type

description · string

Description of the work item type.

logo_props · object

Logo properties for the work item type.

is_epic · boolean

Whether this work item type is an epic.

is_default · boolean

Whether this is the default work item type.

is_active · boolean

Whether this work item type is active.

level · number

Hierarchical level of the work item type.