Create a project release comment

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

Add a comment to a project release. Set parent_id to post a reply to an existing comment instead of a top-level comment.

Commenting needs both view and edit access to the release. If you can't view the release, the request returns 404. If you can view it but can't edit it, the request returns 403.

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 to comment on.

Body Parameters

comment_html:requiredstring

The comment body as HTML. An empty string is allowed.

parent_id:optionalstring (uuid)

The id of the comment this one replies to. Omit it, or send null, for a top-level comment.

is_resolved:optionalboolean

Create the comment already marked resolved. Defaults to false.

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

See Sparse fields.

Scopes

releases.comments:write

Errors

Status	Code	Cause
400	invalid_request	Missing comment_html, or a parent_id that isn't a UUID.
401	unauthorized	Missing or invalid credentials.
402	payment_required	Project releases aren't enabled on your plan.
403	forbidden	You can view the release but your role in the project can't edit it, or your token scope doesn't allow this.
404	not_found	No release with this id in this project, you can't view the release, 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.

Create a project release comment

curl -X POST \
  "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/releases/3e8a1f52-7c4b-4d9e-a6f1-0b2c5d8e9f14/comments/" \
  -H "X-Api-Key: $PLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "comment_html": "<p>QA signed off on the offline mode build.</p>"
}'

import requests

response = requests.post(
    "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/releases/3e8a1f52-7c4b-4d9e-a6f1-0b2c5d8e9f14/comments/",
    headers={"X-Api-Key": "your-api-key"},
    json={"comment_html": "<p>QA signed off on the offline mode build.</p>"},
)
print(response.json())

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/",
  {
    method: "POST",
    headers: {
      "X-Api-Key": "your-api-key",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      comment_html: "<p>QA signed off on the offline mode build.</p>",
    }),
  },
);
const data = await response.json();

Response201

{
  "id": "9a4e7c21-6b3d-4f58-8e12-7d0c5b9a3f46",
  "release_id": "3e8a1f52-7c4b-4d9e-a6f1-0b2c5d8e9f14",
  "comment_id": "2f8c1d6e-5a9b-4e37-b4c0-8e1f7a2d9c53",
  "comment_html": "<p>QA signed off on the offline mode build.</p>",
  "parent_id": null,
  "edited_at": null,
  "is_resolved": false,
  "is_hidden": false,
  "created_at": "2026-02-20T10:14:07.552190Z",
  "updated_at": "2026-02-20T10:14:07.552190Z",
  "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "updated_by_id": null
}