Add Task Comment

Comment on a task. Mentioned staff members are notified.

POST /api/v1/tasks/{task_id}/comments

Add Task Comment

cURL

curl --request POST \
  --url https://{tenant_id}.api.useago.com/api/v1/tasks/{task_id}/comments \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "content": "<string>",
  "mention_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'

201

{
  "id": "<string>",
  "task_id": "<string>",
  "content": "<string>",
  "mentions": [
    {
      "id": "<string>",
      "name": "<string>",
      "email": "<string>"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "author": {
    "id": "<string>",
    "name": "<string>",
    "email": "<string>"
  },
  "edited_at": "2023-11-07T05:31:56Z"
}

Authorizations

X-API-Key · string · header · required

Headers

Idempotency-Key · string | null

Path Parameters

task_id · string · required

Task UUID or identifier such as TASK-12

Body

application/json

content · string · required

Maximum string length: 10000

mention_ids · string<uuid>[]

Maximum array length: 20

Response

201 - application/json

Created

id · string · required

task_id · string · required

content · string · required

mentions · TaskUserRef · object[] · required

Show child attributes

created_at · string<date-time> · required

author · TaskUserRef · object | null

Show child attributes

edited_at · string<date-time> | null