Update comment

PUT /data/comments/{instance_id}
Jwt authorization

Update a comment with data provided in the request body. JSON format is expected. May update task status if task_status_id is changed.

Path parameters

  • instance_id string(uuid) Required
application/json

Body Required

  • text string
  • task_status_id string(uuid)
  • pinned boolean
  • checklist array[object]

Responses

  • 200 application/json

    Comment updated successfully

    Hide response attributes Show response attributes object
    • id string(uuid)
    • object_id string(uuid)
    • person_id string(uuid)
    • task_status_id string(uuid)
    • text string
    • pinned boolean
    • created_at string(date-time)
    • updated_at string(date-time)
  • 400

    Invalid data format or validation error

PUT /data/comments/{instance_id} 
curl \
 --request PUT 'http://api.example.com/data/comments/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"text":"Updated comment text","task_status_id":"b24a6ea4-ce75-4665-a070-57453082c25","pinned":true,"checklist":[{"text":"Item 1","checked":false}]}'
Request examples 
{
  "text": "Updated comment text",
  "task_status_id": "b24a6ea4-ce75-4665-a070-57453082c25",
  "pinned": true,
  "checklist": [
    {
      "text": "Item 1",
      "checked": false
    }
  ]
}
Response examples (200) 
{
  "id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "object_id": "b24a6ea4-ce75-4665-a070-57453082c25",
  "person_id": "c24a6ea4-ce75-4665-a070-57453082c25",
  "task_status_id": "d24a6ea4-ce75-4665-a070-57453082c25",
  "text": "Updated comment text",
  "pinned": true,
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T11:00:00Z"
}