Skip to content

Create a workspace work item template ​

POST/api/v2/workspaces/{slug}/work-item-templates/

Workspace work item templates pre-fill new work items across projects. Create a workspace work item template.

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.

Body parameters ​

name:requiredstring

Display name.

Maximum 255 characters.

template_data:requiredobject

The work item seed: the values the template pre-fills on new work items. You send it on create and update, and reads return it under template_data.

description_html:optionalstring

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

is_published:optionalboolean

Whether the template is published.

short_description:optionalstring

A short summary of the template.

Nullable.

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 ​

StatusCodeCause
400invalid_requestThe request body or a query parameter failed validation.
401unauthorizedMissing or invalid credentials.
402payment_requiredThe feature this endpoint belongs to isn't enabled on your plan or is switched off.
403forbiddenYour role or token scope doesn't allow this.
404not_foundNo such resource, or it's outside your tenant.
406not_acceptableThe Accept header asks for a representation the API can't produce.
409governance_migration_in_progressA governance migration is running in this workspace, so writes are paused. Retry after it finishes.
413payload_too_largeThe request body is over the size limit.
415unsupported_media_typeThe Content-Type isn't one this endpoint accepts.
429rate_limitedThrottled. Honor the Retry-After header before retrying.
Create a workspace work item template
bash
curl -X POST \
  "https://api.plane.so/api/v2/workspaces/my-team/work-item-templates/" \
  -H "X-Api-Key: $PLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Example name",
  "template_data": {
    "assignees": null,
    "description_html": "<p>Details go here.</p>",
    "labels": null,
    "modules": null,
    "name": "Example name",
    "priority": "high",
    "properties": null,
    "state": null,
    "type": null
  },
  "description_html": "<p>Details go here.</p>",
  "is_published": false,
  "short_description": "example"
}'
Response201
json
{
  "created_at": "2026-01-14T09:22:41.478363Z",
  "updated_at": "2026-01-14T09:22:41.478363Z",
  "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "updated_by_id": null,
  "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"
}