Update a workspace page template

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

Change a workspace page template's name, description, publication flag, or page seed. Pages 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 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 workspace page templates.
404	not_found	No workspace page template with this id. Project page templates also return 404 here.
406	not_acceptable	The Accept header asks for a representation the API can't produce.
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": "Updated notes"}} 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 workspace page template

curl -X PATCH \
  "https://api.plane.so/api/v2/workspaces/my-team/page-templates/3d8b2f4e-6a1c-4e57-9b02-7c5d1e8f4a36/" \
  -H "X-Api-Key: $PLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Weekly sync v2",
  "template_data": {
    "name": "Weekly sync notes",
    "description_html": "<h2>Agenda</h2><ul><li><p>Updates</p></li><li><p>Blockers</p></li><li><p>Decisions</p></li></ul>",
    "color": "#3f76ff",
    "view_props": { "full_width": false },
    "logo_props": { "in_use": "emoji", "emoji": { "value": "128221" } }
  }
}'

import requests

response = requests.patch(
    "https://api.plane.so/api/v2/workspaces/my-team/page-templates/3d8b2f4e-6a1c-4e57-9b02-7c5d1e8f4a36/",
    headers={"X-Api-Key": "your-api-key"},
    json={
        "name": "Weekly sync v2",
        "template_data": {
            "name": "Weekly sync notes",
            "description_html": "<h2>Agenda</h2><ul><li><p>Updates</p></li><li><p>Blockers</p></li><li><p>Decisions</p></li></ul>",
            "color": "#3f76ff",
            "view_props": {"full_width": False},
            "logo_props": {"in_use": "emoji", "emoji": {"value": "128221"}},
        },
    },
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v2/workspaces/my-team/page-templates/3d8b2f4e-6a1c-4e57-9b02-7c5d1e8f4a36/",
  {
    method: "PATCH",
    headers: {
      "X-Api-Key": "your-api-key",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      name: "Weekly sync v2",
      template_data: {
        name: "Weekly sync notes",
        description_html:
          "<h2>Agenda</h2><ul><li><p>Updates</p></li><li><p>Blockers</p></li><li><p>Decisions</p></li></ul>",
        color: "#3f76ff",
        view_props: { full_width: false },
        logo_props: { in_use: "emoji", emoji: { value: "128221" } },
      },
    }),
  },
);
const data = await response.json();

Response200

{
  "id": "3d8b2f4e-6a1c-4e57-9b02-7c5d1e8f4a36",
  "name": "Weekly sync v2",
  "short_description": "Agenda and notes for the weekly team sync",
  "description_html": "<p>Use this for the Monday team sync.</p>",
  "template_type": "page",
  "is_published": false,
  "short_id": "k3x9p2",
  "slug": "weekly-sync-v2",
  "project_id": null,
  "template_data": {
    "name": "Weekly sync notes",
    "description_html": "<h2>Agenda</h2><ul><li><p>Updates</p></li><li><p>Blockers</p></li><li><p>Decisions</p></li></ul>",
    "color": "#3f76ff",
    "parent": {},
    "view_props": {
      "full_width": false
    },
    "logo_props": {
      "emoji": {
        "value": "128221"
      },
      "in_use": "emoji"
    }
  },
  "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"
}