latestOpenAPI 3.1.02026-08-211061591.1 MB

69a962f1578f

Comments

Update Comment

Update a comment by ID and returns its content

post/api/v1/comments/{comment_id}

Path parameters

comment_idstring required

String ID of the comment

Example:6XGgmFQrx44wfGHr

Request body

contentstring nullable required

New content for the comment. If null or an empty string, no update is performed.

Example request

{
  "content": "Need two bottles of milk"
}

Response

Successful Response

idstring required

String ID of the comment.

posted_uidstring nullable required

String ID of the user who posted the comment.

contentstring

Comment content.

file_attachmentobject nullable required

File attachment metadata, or null when the comment has no attachment.

uids_to_notifystring[] nullable required

String IDs of users notified by the comment.

is_deletedboolean required

Whether the comment is deleted.

posted_atstring date-time nullable required

Date and time when the comment was posted, or null if unknown.

reactionsobject nullable required

Reaction emoji mapped to user IDs that reacted.

Example response

{
  "id": "6XGgmFQrx44wfGHr",
  "posted_uid": "1234567",
  "content": "Looks good to me.",
  "uids_to_notify": [
    "1234567"
  ],
  "posted_at": "2025-01-15T10:30:00Z",
  "reactions": {
    "👍": [
      "1234567"
    ]
  }
}