Comments

Update a comment

Edit the comment body or resolution. Only the author can edit the body.

patch/projects/{projectId}/comments/{commentId}

Request

Base URL: https://next-api.saturation.io/v1
URL: https://next-api.saturation.io/v1/projects/{projectId}/comments/{commentId}
Auth: HTTP bearer

Request body

contentstring

resolvedboolean

reactionEmojisstring[]

Replaces the current user's reactions. Duplicate emoji are ignored.

Example request

{
  "tags": [
    {
      "targetId": "txn_8f2a1c9e"
    }
  ]
}

Response

The updated comment.

idstring required

A stable resource ID, such as prj_…, txn_…, or doc_….

projectIdstring required

A stable resource ID, such as prj_…, txn_…, or doc_….

threadIdstring

A stable resource ID, such as prj_…, txn_…, or doc_….

contentstring required

Markdown comment body.

resolvedboolean required

Whether the comment thread is resolved.

replyCountinteger required

readByCurrentUserboolean required

editedboolean required

createdAtstring date-time required

updatedAtstring date-time required

Example response

{
  "id": "txn_8f2a1c9e",
  "projectId": "txn_8f2a1c9e",
  "threadId": "txn_8f2a1c9e",
  "target": {
    "id": "txn_8f2a1c9e"
  },
  "author": {
    "id": "txn_8f2a1c9e"
  },
  "tags": [
    {
      "id": "txn_8f2a1c9e",
      "targetId": "txn_8f2a1c9e"
    }
  ],
  "reactions": [
    {
      "users": [
        {
          "id": "txn_8f2a1c9e"
        }
      ]
    }
  ]
}

Changes

Changes to this operation have not been checked yet.