Skip to main content
PATCH
/
api
/
v1
/
workspaces
/
{workspace_slug}
/
projects
/
{project_id}
/
work-items
/
{work_item_id}
/
comments
/
{comment_id}
/
Update a work item comment
curl --request PATCH \
  --url https://api.plane.so/api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/comments/{comment_id}/ \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "comment_html": "<string>",
  "comment_json": {},
  "access": "<string>",
  "external_source": "<string>",
  "external_id": "<string>"
}'

​
Path parameters

​
workspace_slug
string
required
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.
​
project_id
string
required
The unique identifier of the project.
​
work_item_id
string
required
The unique identifier for the work item.
​
comment_id
string
required
The unique identifier for the comment.

​
Body parameters

​
comment_html
string
HTML-formatted version of the comment.
​
comment_json
object
JSON representation of the comment structure.
​
access
string
Visibility level of the comment. Possible values: INTERNAL, EXTERNAL.
​
external_source
string
Identifier for the external source.
​
external_id
string
ID from the external source.