Edit an existing comment. Updates are partial: send only the fields you want to change, and everything you omit is left untouched. There is no PUT.
Plane sets edited_at on the comment when the update succeeds. Clients use it to show an "edited" marker. When you send comment_html, the plain-text comment_stripped is re-derived from it in the same write, so search stays in sync with the visible body.
Editing is not restricted to your own comment id
Whether you can edit a given comment is decided by your role and token scope, not by a body field. A comment you are not allowed to edit returns 403 forbidden; a comment on another work item returns 404.
Replacement body for the comment, as HTML. It overwrites the previous body. There is no append mode, so send the full new text.
access:optionalstring
Change the comment's visibility.
INTERNAL: visible to the project team
EXTERNAL: marked as visible outside the team, for example on a published project
A reply always has its parent's access, so changing access on a reply has no effect. Changing it on a top-level comment changes it on every reply to that comment as well.
parent_id:optionalstring (uuid)
Make the comment a reply to this comment, or send null to make it a top-level comment. The parent must be a top-level comment on the same work item, and a comment can't be its own parent. Anything else returns 400 on parent_id.
external_id:optionalstring
Your system's identifier for this comment. Maximum 255 characters. Accepts null to clear the correlation.
external_source:optionalstring
The system external_id came from, for example github or zendesk. Maximum 255 characters. Accepts null.
external_id is a correlation field, not a key: nothing stops two comments on the same work item from carrying the same value, so keep your own side of the mapping authoritative.
Comma-separated list of fields to return. Fields you don't request are left out of the response instead of coming back as null, so a missing key means you didn't ask for it and null means the value is null. id is always included, whether or not you name it.
Pass all to get every requestable field. An unknown field name returns 400 with the list of valid names and the closest match, so a typo is caught instead of being silently ignored.
Comma-separated relations to embed alongside the ids: actor (the comment author).
Expanded objects get their own key: ?expand=state keeps state_id and adds a state object next to it, so an id is never replaced by an object. An unknown value returns 400.
?fields= and ?expand= take separate sets of names. Relation names aren't valid in ?fields=, field names aren't valid in ?expand=, and field filtering never removes an expanded object: ?fields=id,name&expand=state returns id, name and state. See Expanding relations.
An access value outside the enum, an external_id over 255 characters, or a parent_id that isn't a top-level comment on this work item.
401
unauthorized
Missing or invalid credentials.
402
payment_required
The feature this endpoint belongs to isn't enabled on your plan, or is switched off.
403
forbidden
Your role or token scope can't edit this comment.
404
not_found
No such comment, it belongs to another work item, or it's outside your tenant.
406
not_acceptable
The Accept header asks for a representation the API can't produce.
409
conflict
The update conflicts with the current state of the comment.
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.
Update a comment
bash
curl -X PATCH \ "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/work-items/8f4c2b1e-0d3a-4f7b-9c21-6e5a8b7d4f13/comments/c1f7a3d9-2b64-4f80-9c1a-3d5e8b2a6c47/" \ -H "X-Api-Key: $PLANE_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "comment_html": "<p>Deployed the fix to staging and production.</p>"}'
python
import requestsresponse = requests.patch( "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/work-items/8f4c2b1e-0d3a-4f7b-9c21-6e5a8b7d4f13/comments/c1f7a3d9-2b64-4f80-9c1a-3d5e8b2a6c47/", headers={"X-Api-Key": "your-api-key"}, json={"comment_html": "<p>Deployed the fix to staging and production.</p>"},)print(response.json())
javascript
const response = await fetch( "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/work-items/8f4c2b1e-0d3a-4f7b-9c21-6e5a8b7d4f13/comments/c1f7a3d9-2b64-4f80-9c1a-3d5e8b2a6c47/", { method: "PATCH", headers: { "X-Api-Key": "your-api-key", "Content-Type": "application/json", }, body: JSON.stringify({ comment_html: "<p>Deployed the fix to staging and production.</p>", }), },);const data = await response.json();
Response200
json
{ "id": "c1f7a3d9-2b64-4f80-9c1a-3d5e8b2a6c47", "work_item_id": "8f4c2b1e-0d3a-4f7b-9c21-6e5a8b7d4f13", "parent_id": null, "comment_html": "<p>Deployed the fix to staging and production.</p>", "comment_stripped": "Deployed the fix to staging and production.", "access": "INTERNAL", "actor_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430", "external_id": null, "external_source": null, "edited_at": "2026-01-15T11:04:02.115740Z", "hidden_at": null, "hidden_by_id": null, "hidden_reason": null, "created_at": "2026-01-14T09:22:41.478363Z", "updated_at": "2026-02-03T16:45:12.904117Z", "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430", "updated_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430"}
Response400
json
{ "type": "invalid_request", "code": "invalid_request", "detail": "The request body failed validation.", "errors": [ { "field": "access", "code": "invalid_choice", "message": "\"PUBLIC\" is not a valid choice." } ]}
Update a comment
Edit an existing comment. Updates are partial: send only the fields you want to change, and everything you omit is left untouched. There is no
PUT.Plane sets
edited_aton the comment when the update succeeds. Clients use it to show an "edited" marker. When you sendcomment_html, the plain-textcomment_strippedis re-derived from it in the same write, so search stays in sync with the visible body.Editing is not restricted to your own comment id
Whether you can edit a given comment is decided by your role and token scope, not by a body field. A comment you are not allowed to edit returns
403 forbidden; a comment on another work item returns404.Path parameters
slug:requiredstringThe workspace slug. It appears in your Plane URLs. In
https://app.plane.so/my-team/projects/, the slug ismy-team.project_id:requiredstring (uuid)The project the work item belongs to.
work_item_id:requiredstring (uuid)The work item the comment is attached to.
pk:requiredstring (uuid)The comment to update.
Body parameters
comment_html:optionalstringReplacement body for the comment, as HTML. It overwrites the previous body. There is no append mode, so send the full new text.
access:optionalstringChange the comment's visibility.
INTERNAL: visible to the project teamEXTERNAL: marked as visible outside the team, for example on a published projectA reply always has its parent's
access, so changingaccesson a reply has no effect. Changing it on a top-level comment changes it on every reply to that comment as well.parent_id:optionalstring (uuid)Make the comment a reply to this comment, or send
nullto make it a top-level comment. The parent must be a top-level comment on the same work item, and a comment can't be its own parent. Anything else returns400onparent_id.external_id:optionalstringYour system's identifier for this comment. Maximum 255 characters. Accepts
nullto clear the correlation.external_source:optionalstringThe system
external_idcame from, for examplegithuborzendesk. Maximum 255 characters. Acceptsnull.external_idis a correlation field, not a key: nothing stops two comments on the same work item from carrying the same value, so keep your own side of the mapping authoritative.Response shaping
fields:optionalstringComma-separated list of fields to return. Fields you don't request are left out of the response instead of coming back as
null, so a missing key means you didn't ask for it andnullmeans the value is null.idis always included, whether or not you name it.Pass
allto get every requestable field. An unknown field name returns400with the list of valid names and the closest match, so a typo is caught instead of being silently ignored.Requestable here:
access,actor_id,comment_html,comment_stripped,created_at,created_by_id,edited_at,external_id,external_source,hidden_at,hidden_by_id,hidden_reason,id,parent_id,updated_at,updated_by_id,work_item_id.See Sparse fields.
expand:optionalstringComma-separated relations to embed alongside the ids:
actor(the comment author).Expanded objects get their own key:
?expand=statekeepsstate_idand adds astateobject next to it, so an id is never replaced by an object. An unknown value returns400.?fields=and?expand=take separate sets of names. Relation names aren't valid in?fields=, field names aren't valid in?expand=, and field filtering never removes an expanded object:?fields=id,name&expand=statereturnsid,nameandstate. See Expanding relations.Scopes
projects.work_items.comments:writeErrors
400invalid_requestaccessvalue outside the enum, anexternal_idover 255 characters, or aparent_idthat isn't a top-level comment on this work item.401unauthorized402payment_required403forbidden404not_found406not_acceptableAcceptheader asks for a representation the API can't produce.409conflict413payload_too_large415unsupported_media_typeContent-Typeisn't one this endpoint accepts.429rate_limitedRetry-Afterheader before retrying.