Skip to main content
POST
Create a comment on a post

Authorizations

Authorization
string
header
required

API key authentication. Generate an API key from your workspace settings.

Path Parameters

postId
string<uuid>
required

Post ID (UUID)

Body

application/json
message
string
required

The comment text. Cannot be empty. Supports @mentions using the format @Display Name [blocked]

Minimum string length: 1

Response

Comment created successfully

A comment on a post

id
string<uuid>

Unique identifier for the comment

message
string

The comment text. Mentions use the format @Display Name [blocked]

postId
string<uuid>

The post this comment belongs to

createdAt
string<date-time>

When the comment was created

updatedAt
string<date-time>

When the comment was last updated

user
object

User who created a comment