Update a workspace work item type

PATCH/api/v2/workspaces/{slug}/work-item-types/{pk}/

Rename a type, rewrite its description, or retire it with is_active: false. You make the edit once, and every project working from the workspace list sees it, which is the purpose of managing types at the workspace level.

The update is partial: omitted fields are left untouched, and omitting a field is not the same as sending null. There is no PUT.

Workspace mode required

This write only succeeds while the workspace manages work item types at the workspace level. In project mode it returns 409 with code work_item_types_managed_at_project. See Work item type modes.

Path parameters

slug:requiredstring

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

pk:requiredstring (uuid)

The id of the work item type to update.

Body parameters

Every field is optional. Send only what changes.

name:optionalstring

New display name. Maximum 255 characters. Renaming is safe for integrations that key on id. Anything matching on the old name breaks, so key on id.

description:optionalstring

New description of what the type is for.

is_active:optionalboolean

Send false to retire the type from pickers without deleting it. Work items already classified with it keep their type. Send true to bring it back.

external_id:optionalstring

Your system's identifier for this type. Maximum 255 characters. Send null to clear it.

external_source:optionalstring

The system external_id came from, for example jira. Maximum 255 characters. Send null to clear it.

is_default, is_epic, level, and logo_props are read-only, and sending them has no effect. To change which type is the default, call Mark a type as default.

Response shaping

fields:optionalstring

Comma-separated list of fields to return. Fields you don't request are left out of the response instead of coming back as null, so a missing key means you didn't ask for it and null means the value is null. id is always included, whether or not you name it.

Pass all to get every requestable field. An unknown field name returns 400 with the list of valid names and the closest match, so a typo is caught instead of being silently ignored.

Requestable here: created_at, description, external_id, external_source, governance_mode, id, is_active, is_active_in_project, is_default, is_default_in_project, is_epic, level, logo_props, name, project_ids, rollout, updated_at, updated_by_id.

See Sparse fields.

Scopes

workspaces.work_item_types:write

Errors

Status	Code	Cause
400	invalid_request	An invalid value, for example a name over 255 characters. See errors[].
400	invalid_request	Another workspace type already uses this name, ignoring case.
401	unauthorized	Missing or invalid credentials.
402	payment_required	The feature this endpoint belongs to isn't enabled on your plan, or is switched off.
403	forbidden	Your role or token scope can't write workspace types.
404	not_found	No such type or workspace, or it's outside your tenant.
406	not_acceptable	The Accept header asks for a representation the API can't produce.
409	conflict	Another workspace type already uses this external_id and external_source pair. The response id names it.
413	payload_too_large	The request body is over the size limit.
415	unsupported_media_type	The Content-Type isn't one this endpoint accepts.
429	rate_limited	Throttled. Honor the Retry-After header before retrying.

Update a workspace work item type

curl -X PATCH \
  "https://api.plane.so/api/v2/workspaces/my-team/work-item-types/c1a7d3f4-6b28-4e90-8d15-2f7a0b9c4e63/" \
  -H "X-Api-Key: $PLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Defect",
  "description": "A confirmed break in shipped behavior"
}'

import requests

response = requests.patch(
    "https://api.plane.so/api/v2/workspaces/my-team/work-item-types/c1a7d3f4-6b28-4e90-8d15-2f7a0b9c4e63/",
    headers={"X-Api-Key": "your-api-key"},
    json={
        "name": "Defect",
        "description": "A confirmed break in shipped behavior",
    },
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v2/workspaces/my-team/work-item-types/c1a7d3f4-6b28-4e90-8d15-2f7a0b9c4e63/",
  {
    method: "PATCH",
    headers: {
      "X-Api-Key": "your-api-key",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      name: "Defect",
      description: "A confirmed break in shipped behavior",
    }),
  },
);
const data = await response.json();

Response200

{
  "id": "c1a7d3f4-6b28-4e90-8d15-2f7a0b9c4e63",
  "name": "Defect",
  "description": "A confirmed break in shipped behavior",
  "logo_props": {},
  "is_epic": false,
  "is_default": false,
  "is_active": true,
  "level": 0,
  "governance_mode": "any",
  "rollout": "none",
  "project_ids": ["4af68566-94a4-4eb3-94aa-50dc9427067b", "7c19e5b3-2d84-4f6a-b0e7-93a1c5d8f246"],
  "external_id": null,
  "external_source": null,
  "created_at": "2026-01-14T09:22:41.478363Z",
  "updated_at": "2026-02-03T16:45:12.904117Z",
  "updated_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430"
}

Response409

{
  "type": "conflict",
  "code": "work_item_types_managed_at_project",
  "detail": "This workspace manages work item types at the project level. Update the type on the project's work item types endpoint."
}

Deactivate before you delete

is_active: false is reversible: the type stops appearing in pickers, existing work items keep their classification, and you can undo it with one call. Use Delete only when the type should be removed permanently.