Update a project page template

PATCH/api/v2/workspaces/{slug}/projects/{project_id}/page-templates/{pk}/

Change a project page template's name, description, publication flag, or page seed. Pages already created from the template don't change, and the template stays in its project.

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.

In a workspace with workspace governance turned on, this route returns 409 templates_managed_at_workspace and changes nothing. The checks run in order. An unknown id returns 404, a missing permission returns 403, and only then does governance return 409.

Turning governance on doesn't move existing project page templates. They stay on these routes, where you can still read them, but update and delete return 409 templates_managed_at_workspace, and the workspace routes return 404 for them.

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.

project_id:requiredstring

The project the template belongs to. Accepts the project UUID or its identifier, for example ENG.

pk:requiredstring (uuid)

The id of the page template to update.

Body parameters

Every field is optional.

name:optionalstring

New display name. Maximum 255 characters. Changing it also regenerates slug. Plane doesn't validate the top-level fields on update, so a longer name or a null returns 500 server_error.

short_description:optionalstring

One-line summary of what the template is for.

description_html:optionalstring

Longer description of the template itself, as HTML. The page body is template_data.description_html.

is_published:optionalboolean

Whether the template is published.

template_data:optionalobject

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

• name (string, required). Title of the page created from the template. Maximum 255 characters.
• description_html (string). Resets to <p></p> when omitted.
• color (string). Resets to an empty string when omitted.
• parent (object). Resets to {} when omitted. A non-empty parent needs id, project_id, and project_identifier.
• view_props (object). Resets to {} when omitted.
• logo_props (object). 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, 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, created_by_id, description_html, id, is_published, name, project_id, short_description, short_id, slug, template_data, template_type, updated_at, updated_by_id.

See Sparse fields.

Scopes

templates.pages:write

Errors

Status	Code	Cause
400	invalid_request	template_data is missing name, has a value over its length limit, or has a malformed parent.
401	unauthorized	Missing or invalid credentials.
402	payment_required	Page templates aren't in your plan, or the feature is switched off for this workspace.
403	forbidden	Your role or token scope can't edit page templates in this project.
404	not_found	No page template with this id in this project. Workspace templates and other projects' templates also return 404.
406	not_acceptable	The Accept header asks for a representation the API can't produce.
409	templates_managed_at_workspace	The workspace has governance turned on, so project page templates are read-only.
409	governance_migration_in_progress	The workspace is migrating to workspace governance. Writes are blocked until it finishes, so retry later.
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.

template_data is not merged

Sending {"template_data": {"name": "Postmortem v2"}} sets the new title and resets the body, color, parent, view settings, and icon to their defaults. To change one key, read the template, edit the key in the template_data you got back, and send the whole object.

Update a project page template

curl -X PATCH \
  "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/page-templates/9e1c7a52-3b4d-4f86-a0d2-5c8e7b1f3a94/" \
  -H "X-Api-Key: $PLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "is_published": true
}'

import requests

response = requests.patch(
    "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b"
    "/page-templates/9e1c7a52-3b4d-4f86-a0d2-5c8e7b1f3a94/",
    headers={"X-Api-Key": "your-api-key"},
    json={"is_published": True},
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b" +
    "/page-templates/9e1c7a52-3b4d-4f86-a0d2-5c8e7b1f3a94/",
  {
    method: "PATCH",
    headers: {
      "X-Api-Key": "your-api-key",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({ is_published: true }),
  },
);
const data = await response.json();

Response200

{
  "id": "9e1c7a52-3b4d-4f86-a0d2-5c8e7b1f3a94",
  "name": "Incident postmortem",
  "short_description": "Timeline, impact, root cause, and follow-ups",
  "description_html": "<p>Fill this in within 48 hours of an incident.</p>",
  "template_type": "page",
  "is_published": true,
  "short_id": "m5v8c1",
  "slug": "incident-postmortem",
  "project_id": "4af68566-94a4-4eb3-94aa-50dc9427067b",
  "template_data": {
    "name": "Postmortem",
    "description_html": "<h2>Timeline</h2><p></p><h2>Impact</h2><p></p><h2>Root cause</h2><p></p><h2>Follow-ups</h2><p></p>",
    "color": "#e5484d",
    "parent": {
      "id": "c2f5a8d1-7e3b-4c96-8a14-0b9d6e2f5c71",
      "project_id": "4af68566-94a4-4eb3-94aa-50dc9427067b",
      "project_identifier": "ENG"
    },
    "view_props": {
      "full_width": true
    },
    "logo_props": {}
  },
  "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"
}

Response409

{
  "type": "conflict",
  "code": "templates_managed_at_workspace",
  "detail": "Templates are managed at the workspace level."
}