Skip to main content
POST
/
comments
/
v1
Add a comment
curl --request POST \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/comments/v1 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: <content-type>' \
  --header 'X-Session-Token: <x-session-token>' \
  --data '
{
  "comment": "This is a comment.",
  "origin": {
    "type": 1,
    "id": 123
  }
}
'
{
  "data": {
    "id": 1,
    "profileId": 42,
    "comment": "This is a comment.",
    "metadata": {
      "key": "value"
    },
    "commentType": 1,
    "anomalyId": 5,
    "updatedAt": "2025-05-06T12:00:00.000Z",
    "createdAt": "2025-05-01T09:30:00.000Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Content-Type
enum<string>
required

Content type, must be "application/json".

Available options:
application/json
​
X-Session-Token
string
required

Session token used for authenticating the request.

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIxMjM0NTY3ODkwIiwic2Vzc2lvbklkIjoiYWJjZGVmMTIzNDU2IiwiaWF0IjoxNjA1MDk3ODk5LCJleHAiOjE2MDUxODQyOTl9.4XRQ1iXDyvEj5LgPZHbmTmzOZs98M3YPOzgf3MhxjaI"

Body

application/json

Details required to add a comment

​
comment
string
required

Content of the comment.

Maximum string length: 2000
Example:

"This is a comment."

​
origin
object
required

Response

200 - application/json

The comment has been created

​
data
object
required