Comments

Create a comment on a post

Add a comment to a post. Supports @mentions using the format @[Display Name](userId). Tagged users must be workspace members. The commenter and any tagged users are automatically subscribed to the post.

post/posts/{postId}/comments

Request

Base URL
https://app.tryordinal.com/api/v1/company
Auth
HTTP bearer
TypeScript
https://skmtc.dev/tryordinal/apis/ordinal-agency-api/docs/posts/:postId/comments/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

postIdstring uuid required

Post ID (UUID)

Request body

messagestring required

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

Response

Comment created successfully

idstring uuid

Unique identifier for the comment

messagestring

The comment text. Mentions use the format @Display Name

postIdstring uuid

The post this comment belongs to

createdAtstring date-time

When the comment was created

updatedAtstring date-time

When the comment was last updated

Changes

No recorded changes to this operation across all 1 revision of this API.