STstreakyc
Comments

Update comment

Changed on

Updates a comment by key

post/v2/comments/{commentKey}

Request

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

Path parameters

commentKeystring required

Request body

messagestring nullable

New comment text. Omit this field to keep the existing comment text unchanged.

Response

OK

keystring required

Key for this comment.

boxKeystring required

Key for the box this comment belongs to.

pipelineKeystring required

Key for the pipeline this comment belongs to.

creatorKeystring required

Key for the user who created this comment.

newsfeedEntryKeystring nullable

Key for the newsfeed entry created for this comment.

timestampinteger nullable

Timestamp when the comment was created, in epoch milliseconds.

messagestring nullable

Comment text.

parentstring nullable

Key for the parent comment, when this comment is a reply.

childrenstring[] nullable

Keys for this comment's direct replies.

lastSavedTimestampinteger nullable

Timestamp when the comment was last persisted, in epoch milliseconds.

Example response

{
  "timestamp": 1646870400000,
  "lastSavedTimestamp": 1646870400000
}

Changes