Sign in

v1

latestOpenAPI 3.0.0http://www.apache.org/licenses/LICENSE-2.0.html2026-07-14543167.2 KB
channels

Create a new comment

put/comments

Request body

textstring required

See the Rich Text page to learn more about formatting

threadIDstring uuid required
parentCommentIDstring uuid nullable required

Heartbeat comments have two levels of nesting. If null is provided, then the comment will be a direct reply to the thread. If a comment id is provided, then the comment will be a reply to that comment. The provided comment id must be a comment that is a direct reply to the thread.

userIDstring uuid

The user that will be shown as the author of the comment. Only an admin user can be chosen. If this field is not provided, the user that created the API key will be used

createdAtstring date-time

Optional timestamp to override the default creation time for the comment. Must be in ISO 8601 format.

Example request

{
  "text": "<p>Hello!</p>",
  "createdAt": "2023-10-15T14:30:00.000Z"
}

Response

Successful response

idstring uuid
userIDstring uuid

The id of the user that created this comment

contentstring

The content of the comment

imagesstring[]

A list of URLs pointing to any image attachments on the comment

filesstring[]

A list of URLs pointing to any file attachments on the comment

createdAtstring date-time

Example response

{
  "content": "<p>This is the comments's content</p>",
  "children": [
    {
      "content": "<p>This is the comments's content</p>"
    }
  ]
}