Delete a project release

DELETE/api/v2/workspaces/{slug}/projects/{project_id}/releases/{pk}/

Delete a release from a project. A successful delete returns 204 with an empty body.

Deleting needs the delete permission on the release in its project, which is separate from the edit permission that updates use.

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 release belongs to. Accepts the project UUID or its bare identifier, for example ENG.

pk:requiredstring (uuid)

The id of the release to delete.

Response shaping

fields:optionalstring

Comma-separated list of fields to return. A successful delete has no body, so this has no visible effect. See Sparse fields.

Requestable here: created_at, created_by_id, description_html, description_id, external_id, external_source, id, is_latest, is_prerelease, label_ids, lead_id, name, project_id, release_date, status, tag_id, target_date, updated_at, updated_by_id.

expand:optionalstring

Comma-separated relations to embed: lead, tag. A successful delete has no body, so this has no visible effect. See Expanding relations.

Scopes

releases:write

Errors

Status	Code	Cause
400	invalid_request	The request body or a query parameter failed validation.
401	unauthorized	Missing or invalid credentials.
402	payment_required	Project releases aren't enabled on your plan.
403	forbidden	Your role in the project can't delete this release, or your token scope doesn't allow this.
404	not_found	No release with this id in this project, or no such workspace or project.
406	not_acceptable	The Accept header asks for a representation the API can't produce.
409	conflict	Not raised by this endpoint. The spec lists it for every v2 write.
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 release

curl -X DELETE \
  "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/releases/3e8a1f52-7c4b-4d9e-a6f1-0b2c5d8e9f14/" \
  -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/releases/3e8a1f52-7c4b-4d9e-a6f1-0b2c5d8e9f14/",
    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/releases/3e8a1f52-7c4b-4d9e-a6f1-0b2c5d8e9f14/",
  {
    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."
}