Endpoint#
| Property | Value |
|---|
| Type | mutation |
| Method | POST |
| Path | /api/external/v1/delete_comment |
| Handler | OperatelyWeb.Api.Mutations.DeleteComment |
Authentication#
- Requires a valid API token.
- Requires a write-enabled token.
- Read-only tokens return
403.
| Field | Type | Required | Nullable | Default |
|---|
comment_id | id primitive (encoded as string) | Yes | No | - |
parent_type | comment_parent_type enum (project_check_in, project_retrospective, comment_thread, goal_update, message, resource_hub_document, resource_hub_file, resource_hub_link, space_task, project_task, milestone) | Yes | No | - |
Outputs#
| Field | Type | Required | Nullable |
|---|
comment | comment object | Yes | No |
cURL Example#
Copiedcurl --request POST \
--url "https://app.operately.com/api/external/v1/delete_comment" \
--header "Authorization: Bearer ${OPERATELY_API_TOKEN}" \
--header "Content-Type: application/json" \
--data '{"comment_id":"value", "parent_type":"project_check_in"}'
Response Example#
{
"comment": {
"author": "<person>",
"content": "value",
"id": "value",
"inserted_at": "2026-01-01T09:30:00Z",
"notification": "<notification>",
"reactions": [
"<reaction>"
]
}
}