Comments API: Create

Endpoint#

Property	Value
Type	mutation
Method	POST
Path	/api/external/v1/comments/create
Handler	OperatelyWeb.Api.Comments.Create

Authentication#

• Requires a valid API token.
• Requires a write-enabled token.
• Read-only tokens return 403.

Inputs#

Field	Type	Required	Nullable	Default
entity_id	id primitive (encoded as string)	Yes	No	-
entity_type	comment_parent_type enum (project_check_in, project_retrospective, project_discussion, goal_update, goal_discussion, message, resource_hub_document, resource_hub_file, resource_hub_link, space_task, project_task, milestone, kpi_entry)	Yes	No	-
content	json primitive (encoded as string)	Yes	No	-

Outputs#

Field	Type	Required	Nullable
comment	comment object	Yes	No

cURL Example#

Copied

curl --request POST \
  --url "https://app.operately.com/api/external/v1/comments/create" \
  --header "Authorization: Bearer ${OPERATELY_API_TOKEN}" \
  --header "Content-Type: application/json" \
  --data '{"content":"value", "entity_id":"value", "entity_type":"project_check_in"}'

Response Example#

{
  "comment": {
    "__typename": "value",
    "author": "<person>",
    "content": "value",
    "id": "value",
    "inserted_at": "2026-01-01T09:30:00Z",
    "notification": "<notification>",
    "reactions": [
      "<reaction>"
    ]
  }
}