Delete a workspace page template

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

Remove a workspace page template. A successful delete returns 204 with an empty body, and the template drops out of the list and the template picker. Pages already created from it are not affected.

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.

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 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.

Delete a workspace page template

curl -X DELETE \
  "https://api.plane.so/api/v2/workspaces/my-team/page-templates/3d8b2f4e-6a1c-4e57-9b02-7c5d1e8f4a36/" \
  -H "X-Api-Key: $PLANE_API_KEY"

import requests

response = requests.delete(
    "https://api.plane.so/api/v2/workspaces/my-team/page-templates/3d8b2f4e-6a1c-4e57-9b02-7c5d1e8f4a36/",
    headers={"X-Api-Key": "your-api-key"},
)
print(response.status_code)

const response = await fetch(
  "https://api.plane.so/api/v2/workspaces/my-team/page-templates/3d8b2f4e-6a1c-4e57-9b02-7c5d1e8f4a36/",
  {
    method: "DELETE",
    headers: {
      "X-Api-Key": "your-api-key",
    },
  },
);
console.log(response.status);

Response204

No response body.

Response404

{
  "type": "not_found",
  "code": "not_found",
  "detail": "The requested resource was not found."
}