Skip to main content
POST
/
posts
/
{postId}
/
comments
Create a comment on a post
curl --request POST \
  --url https://app.tryordinal.com/api/v1/posts/{postId}/comments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "message": "Looks good! @[Jane Smith](550e8400-e29b-41d4-a716-446655440002) can you review the first paragraph?"
}
'
{
  "id": "b2c3d4e5-6f7a-8b9c-0d1e-2f3a4b5c6d7e",
  "message": "Looks good! @[Jane Smith](550e8400-e29b-41d4-a716-446655440002) can you review the first paragraph?",
  "postId": "d4f8e2a1-3b7c-4e9d-8f2a-1c5b9e7d3a6f",
  "createdAt": "2026-02-04T11:00:00.000Z",
  "updatedAt": "2026-02-04T11:00:00.000Z",
  "user": {
    "id": "550e8400-e29b-41d4-a716-446655440001",
    "firstName": "John",
    "lastName": "Doe",
    "email": "john@example.com"
  }
}

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

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

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