Create a work item comment

POST/api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/comments/

Creates a new comment on a work item.

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.

project_id:requiredstring

The unique identifier of the project.

work_item_id:requiredstring

The unique identifier for the work item.

Body Parameters

comment_html:optionalstring

HTML-formatted version of the comment.

comment_json:optionalobject

JSON representation of the comment structure.

access:optionalstring

Visibility level of the comment. Possible values: INTERNAL, EXTERNAL.

external_source:optionalstring

Identifier for the external source.

external_id:optionalstring

ID from the external source.

Create a work item comment

curl -X POST \
  "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/comments/" \
  -H "X-API-Key: $PLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "comment_html": "example-comment_html",
  "comment_json": "example-comment_json",
  "access": "example-access",
  "external_source": "example-external_source",
  "external_id": "example-external_id"
}'

import requests

response = requests.post(
    "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/comments/",
    headers={"X-API-Key": "your-api-key"},
    json={
  'comment_html': 'example-comment_html',
  'comment_json': 'example-comment_json',
  'access': 'example-access',
  'external_source': 'example-external_source',
  'external_id': 'example-external_id'
}
)
print(response.json())

const response = await fetch(
  'https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/comments/',
  {
    method: 'POST',
    headers: {
      'X-API-Key': 'your-api-key',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      comment_html: 'example-comment_html',
      comment_json: 'example-comment_json',
      access: 'example-access',
      external_source: 'example-external_source',
      external_id: 'example-external_id',
    }),
  },
);
const data = await response.json();

Response201

{
  "id": "project-uuid",
  "name": "Project Name",
  "identifier": "PROJ",
  "description": "Project description",
  "created_at": "2024-01-01T00:00:00Z"
}