Update a release comment

PATCH/api/v1/workspaces/{workspace_slug}/releases/{release_id}/comments/{comment_id}/

Updates an existing release comment by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path Parameters

workspace_slug:requiredstring

The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL https://app.plane.so/my-team/projects/, the workspace slug is my-team.

release_id:requiredstring

The unique identifier for the release.

comment_id:requiredstring

The unique identifier for the comment.

Body Parameters

comment_html:optionalstring

HTML-formatted content of the comment.

parent:optionalstring

ID of the parent comment, for threaded replies.

is_resolved:optionalboolean

Whether the comment has been resolved.

edited_at:optionalstring

Timestamp when the comment was last edited, in ISO 8601 format.

Scopes

releases.comments:write

Update a release comment

curl -X PATCH \
  "https://api.plane.so/api/v1/workspaces/my-workspace/releases/a1b2c3d4-e5f6-7890-abcd-ef1234567890/comments/c0ffee00-1111-2222-3333-444444444444/" \
  -H "X-API-Key: $PLANE_API_KEY" \
  # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "comment_html": "<p>QA sign-off complete. Retested after hotfix.</p>",
  "is_resolved": true,
  "edited_at": "2025-03-02T10:05:00.000000Z"
}'

import requests

response = requests.patch(
    "https://api.plane.so/api/v1/workspaces/my-workspace/releases/a1b2c3d4-e5f6-7890-abcd-ef1234567890/comments/c0ffee00-1111-2222-3333-444444444444/",
    headers={"X-API-Key": "your-api-key"},
    json={
  'comment_html': '<p>QA sign-off complete. Retested after hotfix.</p>',
  'is_resolved': True,
  'edited_at': '2025-03-02T10:05:00.000000Z'
}
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v1/workspaces/my-workspace/releases/a1b2c3d4-e5f6-7890-abcd-ef1234567890/comments/c0ffee00-1111-2222-3333-444444444444/",
  {
    method: "PATCH",
    headers: {
      "X-API-Key": "your-api-key",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      comment_html: "<p>QA sign-off complete. Retested after hotfix.</p>",
      is_resolved: true,
      edited_at: "2025-03-02T10:05:00.000000Z",
    }),
  },
);
const data = await response.json();

Response200

{
  "id": "c0ffee00-1111-2222-3333-444444444444",
  "created_at": "2025-03-02T09:15:00.000000Z",
  "updated_at": "2025-03-02T10:05:00.000000Z",
  "deleted_at": null,
  "comment": {
    "description_html": "<p>QA sign-off complete. Retested after hotfix.</p>",
    "description_binary": null,
    "description_stripped": "QA sign-off complete. Retested after hotfix.",
    "description_json": {}
  },
  "is_hidden": false,
  "edited_at": "2025-03-02T10:05:00.000000Z",
  "is_resolved": true,
  "created_by": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "updated_by": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "workspace": "cd4ab5a2-1a5f-4516-a6c6-8da1a9fa5be4",
  "release": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "parent": null
}