Delete a project page template

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

Remove a page template from a project. A successful delete returns 204 with an empty body. Pages already created from the template are not affected.

In a workspace with workspace governance turned on, this route returns 409 templates_managed_at_workspace and deletes 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 moves project page templates to the workspace and keeps their ids, so an id from before the move returns 404 here. Delete it with Delete a workspace page template instead.

Path Parameters

slug:requiredstring

The workspace slug. It appears in your Plane URLs, so 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 delete.

Response shaping

fields:optionalstring

Comma-separated list of fields to return. Unrequested keys are omitted from the response, not returned as null, so absent means "not requested" and null means "actually null". id always comes back whether or not you name it.

Pass all for every requestable field. An unknown name is a 400 that lists the valid set and suggests the closest match, so a typo can't silently cost you the saving.

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	The request could not be processed, for example an unknown ?fields= name.
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 delete 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. Delete templates at the workspace level instead.
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.

Delete a project page template

curl -X DELETE \
  "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"

import requests

response = requests.delete(
    "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"},
)
print(response.status_code)

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: "DELETE",
    headers: {
      "X-Api-Key": "your-api-key",
    },
  },
);
console.log(response.status);

Response204

No response body.

Response409

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