Comments

Create a comment

Add a comment to a project resource you can edit.

post/projects/{projectId}/comments

Request

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

Headers

Idempotency-Keystring required

Unique request key, 16 to 255 characters. Retrying the same request returns the first response. Missing or invalid keys return 400 validation; reuse with a different body returns 409 idempotency_conflict.

Request body

contentstring required
threadIdstring

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

Example request

{
  "target": {
    "id": "txn_8f2a1c9e"
  },
  "threadId": "txn_8f2a1c9e",
  "tags": [
    {
      "targetId": "txn_8f2a1c9e"
    }
  ]
}

Response

The created 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

No recorded changes to this operation across all 4 revisions of this API.