Delete a project release comment

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

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

Deleting needs edit access to the release, and returns 403 without it. The API doesn't check who wrote the comment, so anyone who can edit the release can delete any of its comments.

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.

release_id:requiredstring (uuid)

The release the comment is on.

pk:requiredstring (uuid)

The id of the comment 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: comment_html, comment_id, created_at, created_by_id, edited_at, id, is_hidden, is_resolved, parent_id, release_id, updated_at, updated_by_id.

Scopes

releases.comments:write

Errors

Status	Code	Cause
400	invalid_request	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 edit this release, or your token scope doesn't allow this.
404	not_found	No such comment on this release, or no such release in this 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 comment

curl -X DELETE \
  "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/releases/3e8a1f52-7c4b-4d9e-a6f1-0b2c5d8e9f14/comments/9a4e7c21-6b3d-4f58-8e12-7d0c5b9a3f46/" \
  -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/comments/9a4e7c21-6b3d-4f58-8e12-7d0c5b9a3f46/",
    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/comments/9a4e7c21-6b3d-4f58-8e12-7d0c5b9a3f46/",
  {
    method: "DELETE",
    headers: {
      "X-Api-Key": "your-api-key",
    },
  },
);
console.log(response.status);

Response204

No response body.