Update a workspace work item template

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

Workspace work item templates pre-fill new work items across projects. Update a workspace work item template. Work items already created from the template don't change.

The update is partial for the top-level fields. Send only the ones you want to change, and anything you omit keeps its current value. template_data is the exception. When you send it, it replaces the whole seed, as described under Body parameters.

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 workspace work item template id.

Body parameters

description_html:optionalstring

Rich-text body as HTML. The Plane editor reads and writes this field.

is_published:optionalboolean

Whether the template is published.

name:optionalstring

Display name.

Maximum 255 characters. Plane doesn't validate the top-level fields on update, so a longer name or a null returns 500 server_error.

short_description:optionalstring

A short summary of the template.

Nullable.

template_data:optionalobject

A new work item seed. It replaces the stored seed as a whole, so send every key you want to keep:

• name (string, required). Title of the work item created from the template. Maximum 255 characters.
• description_html (string). Resets to <p></p> when omitted.
• priority (string). One of urgent, high, medium, low, or none. Resets to none when omitted.
• state (object). Resets to {} when omitted.
• assignees (array). Resets to [] when omitted.
• labels (array). Resets to [] when omitted.
• type (object). Resets to {} when omitted.
• modules (array). Resets to [] when omitted.
• properties (array). Resets to [] when omitted.

Omit template_data entirely to leave the seed alone.

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. id is always included. Pass all to get every requestable field. An unknown field name returns 400. See Sparse fields.

Requestable here: created_at, created_by_id, description_html, id, is_published, name, short_description, short_id, slug, template_data, template_type, updated_at, updated_by_id.

Scopes

templates.work_items:write

Errors

Status	Code	Cause
400	invalid_request	The request body or a query parameter failed validation.
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 doesn't allow this.
404	not_found	No such resource, or it's outside your tenant.
406	not_acceptable	The Accept header asks for a representation the API can't produce.
409	governance_migration_in_progress	A governance migration is running in this workspace, so writes are paused. Retry after it finishes.
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.
500	server_error	A top-level field breaks a database limit, for example a name over 255 characters or a null name. Update doesn't validate these fields.

Update a workspace work item template

curl -X PATCH \
  "https://api.plane.so/api/v2/workspaces/my-team/work-item-templates/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/" \
  -H "X-Api-Key: $PLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "description_html": "<p>Details go here.</p>",
  "is_published": false,
  "name": "Example name"
}'

import requests

response = requests.patch(
    "https://api.plane.so/api/v2/workspaces/my-team/work-item-templates/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/",
    headers={"X-Api-Key": "your-api-key"},
    json={
        "description_html": "<p>Details go here.</p>",
        "is_published": False,
        "name": "Example name"
    },
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v2/workspaces/my-team/work-item-templates/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/",
  {
    method: "PATCH",
    headers: {
      "X-Api-Key": "your-api-key",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      description_html: "<p>Details go here.</p>",
      is_published: false,
      name: "Example name",
    }),
  },
);
const data = await response.json();

Response200

{
  "created_at": "2026-01-14T09:22:41.478363Z",
  "updated_at": "2026-02-03T16:45:12.904117Z",
  "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "updated_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "description_html": "<p>Details go here.</p>",
  "id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
  "is_published": false,
  "name": "Example name",
  "short_description": "example",
  "short_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "slug": "my-team",
  "template_data": {},
  "template_type": "example"
}

Response404

{
  "type": "not_found",
  "code": "not_found",
  "detail": "No workspace work item template matches the given query."
}