Skip to content
Dashboard

Comments

Threaded discussions on posts and changelogs. Comments support voting, moderation, and privacy controls.

List comments
client.feedback.comments.list(CommentListParams { changelogId, cursor, inReview, 5 more } params?, RequestOptionsoptions?): CursorPage<Comment { id, author, changelogId, 14 more } >
GET/v2/comments
Create a new comment
client.feedback.comments.create(CommentCreateParams { content, author, changelogId, 8 more } params, RequestOptionsoptions?): Comment { id, author, changelogId, 14 more }
POST/v2/comments
Get a comment by ID
client.feedback.comments.retrieve(stringid, CommentRetrieveParams { featurebaseVersion } params?, RequestOptionsoptions?): Comment { id, author, changelogId, 14 more }
GET/v2/comments/{id}
Update a comment
client.feedback.comments.update(stringid, CommentUpdateParams { content, createdAt, downvotes, 5 more } params, RequestOptionsoptions?): Comment { id, author, changelogId, 14 more }
PATCH/v2/comments/{id}
Delete a comment
client.feedback.comments.delete0(stringid, CommentDelete0Params { featurebaseVersion } params?, RequestOptionsoptions?): CommentDelete0Response { id, deleted, object }
DELETE/v2/comments/{id}
Delete a comment
client.feedback.comments.delete1(CommentDelete1Params { id, featurebaseVersion } params, RequestOptionsoptions?): CommentDelete1Response { success }
DELETE/v2/comment
ModelsExpand Collapse
Comment { id, author, changelogId, 14 more }
id: string

Unique identifier

author: Author | null
id: string | null

Author unique identifier

name: string

Author display name

profilePicture: string | null

Author profile picture URL

type: "admin" | "customer" | "guest" | 3 more

Type of user who authored the comment

One of the following:
"admin"
"customer"
"guest"
"integration"
"bot"
"lead"
changelogId: string | null

Changelog ID this comment belongs to

content: string

Comment content in HTML format

createdAt: string

ISO 8601 timestamp when created

downvotes: number

Number of downvotes

inReview: boolean

Whether the comment is in review

isDeleted: boolean

Whether the comment is deleted

isPinned: boolean

Whether the comment is pinned

isPrivate: boolean

Whether the comment is private

isSpam: boolean

Whether the comment is spam

object: "comment"

Object type identifier

parentCommentId: string | null

Parent comment ID for replies, null for root comments

postId: string | null

Post ID this comment belongs to

score: number

Net score (upvotes - downvotes)

updatedAt: string

ISO 8601 timestamp when updated

upvotes: number

Number of upvotes

CommentDelete0Response { id, deleted, object }
id: string

Unique identifier of the deleted comment

deleted: true

Indicates the resource was deleted

object: "comment"

Object type identifier

CommentDelete1Response { success }
success: boolean