User-related API environment

Pre-live user-related API docs

Create a new comment

Add a comment to a post or reply to an existing comment. Supports mentions and notifies the post author.

application/json

Request Body required

Comment with postId and optional parentId

comment object
body string required
Possible values: <= 8000 characters
Comment body text
postId number required
ID of the post this comment belongs to
isPrivate boolean required
Default value: false
Whether the comment is private
parentId number
ID of the parent comment (for replies)
mentions object[]
User mentions in the comment
Array [
marker string required
Possible values: Value must match regular expression /{{[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}}}/
userId string required
displayName string required
]

Responses

• 201
• 400
• 401
• 404

---

Comment created

application/json

Schema

Example (from schema)

---

Schema

comment object required
id number required
postId number required
authorId string required
parentId number required
isPrivate boolean required
Default value: false
body string required
createdAt date-time required
updatedAt date-time required
toxicityScore number
repliesCount number
Default value: 0
likesCount number
Default value: 0
reported boolean
Default value: false
removed boolean
Default value: false
hidden boolean
Default value: false
languageId number
languageName string
moderationStatus number
author object
postsCount number
avatarUrls object required
small string
medium string
large string
id string required
username string
verified boolean
Default value: false
firstName string
lastName string
memberType number
mentions object[]
Array [
postsCount number
avatarUrls object required
small string
medium string
large string
id string required
username string
verified boolean
Default value: false
firstName string
lastName string
memberType number
locations object required
followersCount number required
displayName string
]
tags object[]
Array [
language string
id number required
name string
commentsCount number
]
success boolean required

{
  "comment": {
    "id": 0,
    "postId": 0,
    "authorId": "string",
    "parentId": 0,
    "isPrivate": false,
    "body": "string",
    "createdAt": "2026-03-29T20:06:48.417Z",
    "updatedAt": "2026-03-29T20:06:48.417Z",
    "toxicityScore": 0,
    "repliesCount": 0,
    "likesCount": 0,
    "reported": false,
    "removed": false,
    "hidden": false,
    "languageId": 0,
    "languageName": "string",
    "moderationStatus": 0,
    "author": {
      "postsCount": 0,
      "avatarUrls": {
        "small": "string",
        "medium": "string",
        "large": "string"
      },
      "id": "string",
      "username": "string",
      "verified": false,
      "firstName": "string",
      "lastName": "string",
      "memberType": 0
    },
    "mentions": [
      {
        "postsCount": 0,
        "avatarUrls": {
          "small": "string",
          "medium": "string",
          "large": "string"
        },
        "id": "string",
        "username": "string",
        "verified": false,
        "firstName": "string",
        "lastName": "string",
        "memberType": 0,
        "locations": {},
        "followersCount": 0,
        "displayName": "string"
      }
    ],
    "tags": [
      {
        "language": "string",
        "id": 0,
        "name": "string",
        "commentsCount": 0
      }
    ]
  },
  "success": true
}

Invalid comment - empty body or invalid postId

User not authenticated

Post or parent comment not found

Loading...