Sign in
latestOpenAPI 3.0.02026-08-216686147.9 KB

6f6009a58cdd

comments
requests

Post a Comment on a Request

post/v1/requests/{uuid}/comments

Path parameters

uuidstring uuid required

The UUID of the request to post the comment

Request body

contentstring required
mentioned_user_uuidsstring[]

User UUIDs to mention and notify. Plain-text @Name text does not create mention notifications.

Example request

{
  "content": "<p>The comment text in HTML format</p>",
  "mentioned_user_uuids": [
    "edbf4962-20eb-499e-a7fa-eaff50c81630"
  ]
}

Response

The newly created Comment

Example response

{
  "data": {
    "uuid": "4d50d252-be0c-4d69-b77a-5bbdfef83f54",
    "content": "<p>The comment text in HTML format</p>Employees hired in 2023",
    "author_user_uuid": "4d50d252-be0c-4d69-b77a-5bbdfef83f54",
    "created_at": "2023-01-01T12:30:00.000Z",
    "updated_at": "2023-01-01T12:30:00.000Z",
    "_links": {
      "self": {
        "href": "https://example.com/resource/or/path",
        "title": "A description for the link",
        "type": "text/html"
      }
    }
  }
}