---
title: "Update comment"
method: POST
path: "/v2/comments/{commentKey}"
tags: ["Comments"]
---

# Update comment

`POST /v2/comments/{commentKey}`

## Request

- Base URL: `https://api.streak.com/api`
- URL: `https://api.streak.com/api/v2/comments/{commentKey}`
- Auth: HTTP bearer

Updates a comment by key

## Path parameters

- `commentKey` string, required

## Request body

- CommentUpdateBody
  - `message` string, nullable: New comment text. Omit this field to keep the existing comment text unchanged.
  - `mentions` CommentMentionBody[], nullable: New mention ranges for the comment text. Omit this field to keep existing mentions unchanged.
    - `userKey` string, required: Key for the mentioned user.
    - `offset` integer: Mention start offset in the comment text.
    - `length` integer: Mention length in the comment text.

## Response `200`

OK

- Comment
  - `key` string, required: Key for this comment.
  - `boxKey` string, required: Key for the box this comment belongs to.
  - `pipelineKey` string, required: Key for the pipeline this comment belongs to.
  - `creatorKey` string, required: Key for the user who created this comment.
  - `newsfeedEntryKey` string, nullable: Key for the newsfeed entry created for this comment.
  - `timestamp` integer, nullable: Timestamp when the comment was created, in epoch milliseconds.
  - `message` string, nullable: Comment text.
  - `mentions` CommentMention[], nullable: User mentions found in the comment text.
    - `userKey` string, required: Key for the mentioned user.
    - `offset` integer: Zero-based character offset where the mention starts.
    - `length` integer: Character length of the mention.
  - `parent` string, nullable: Key for the parent comment, when this comment is a reply.
  - `children` string[], nullable: Keys for this comment's direct replies.
  - `reactionSummary` CommentReactionSummary[], required: Emoji reactions grouped by emoji.
    - `emoji` string, required: Emoji used for this reaction group.
    - `count` integer: Number of users who reacted with this emoji.
    - `users` UserBrief[], required: Users who reacted with this emoji, ordered by oldest reaction first.
      - `userKey` string, required: Key for this user.
      - `email` string, nullable: User email address, when available.
      - `displayName` string, nullable: Short display name for this user, when available.
      - `fullName` string, nullable: Full display name for this user, when available.
      - `givenName` string, nullable: Given name for this user, when available.
      - `avatarUrl` string, nullable: Avatar image URL for this user, when available.
  - `lastSavedTimestamp` integer, nullable: Timestamp when the comment was last persisted, in epoch milliseconds.

## Changes

- **2026-10-16** `1c3a5ef8b9ea`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/streakyc/apis/streak/changes/v2/comments/:commentKey/post.md)

---

[API](https://skmtc.dev/streakyc/apis/streak.md) - [All operations](https://skmtc.dev/streakyc/apis/streak/llms.txt) - [OpenAPI document](https://skmtc.dev/streakyc/apis/streak/revisions/3648671fd1cf?raw)