Create Comment

Use comment creation APIs to add comments to posts, stories, or your own custom content IDs. A reply is a normal comment with parentId set to the comment being replied to.

Text Comment

Create top-level comments and replies with text, metadata, mentions, and supported link payloads.

Image Comment

Create comments with uploaded image file IDs.

Parameters

Parameter	Required	Platforms	Description
`referenceId`	Yes	TypeScript, iOS, Android, Flutter	Target content ID for the comment, such as a post ID.
`referenceType`	Yes	TypeScript, iOS, Android, Flutter	Target content type, such as `post`.
`text`	Yes	TypeScript, iOS, Android, Flutter	Text body for the comment or reply shown in these examples.
`parentId`	No	TypeScript, iOS, Android, Flutter	Parent comment ID when creating a reply.
`metadata`	No	TypeScript, iOS, Android, Flutter	App-defined metadata stored with the comment. Set through each platform’s comment builder.
`mentionees` / mention builders	No	TypeScript, iOS, Android, Flutter	Mention targets for text comments. Set through each platform’s comment builder.

In a community that requires comment review, the created comment comes back with a pending approval status: only its author and the community’s reviewers can see it, and it does not move the post’s comment count for anyone else until it is approved. See Approval Lifecycle for when a comment is held and who is exempt. In a community that requires review, create with optimistic creation turned off so the returned comment already carries its approval status — see Read Approval Status on a Comment.

Basic Text Comment

Create a top-level text comment by passing the reference target and text body to the comment repository.

import { CommentRepository } from '@amityco/ts-sdk';

const { data: comment } = await CommentRepository.createComment({
  referenceId: postId,
  referenceType: 'post',
  data: {
    text: 'Hello world!',
  },
});

renderResults(comment);

let options = AmityCommentCreateOptions(
    referenceId: "post-id",
    referenceType: .post,
    text: "Hello world!"
)

let comment = try await commentRepository.createComment(with: options)
showSuccessMessage(comment.commentId)

AmitySocialClient.newCommentRepository()
    .createComment()
    .post(postId = postId)
    .with()
    .text(text = "Hello world!")
    .build()
    .send()
    .subscribe(
        { comment -> showSuccessMessage(comment.getCommentId()) },
        { error -> handleGeneralError(error) },
    )

final comment = await AmitySocialClient.newCommentRepository()
    .createComment()
    .post(postId)
    .create()
    .text('Hello world!')
    .send();

final commentId = comment.commentId;

Reply to a Comment

Create a reply with the same reference target and the parentId of the comment being replied to.

import { CommentRepository } from '@amityco/ts-sdk';

const { data: reply } = await CommentRepository.createComment({
  referenceId: postId,
  referenceType: 'post',
  parentId: commentId,
  data: {
    text: 'Replying to this comment',
  },
});

renderResults(reply);

let options = AmityCommentCreateOptions(
    referenceId: "post-id",
    referenceType: .post,
    text: "Replying to this comment",
    parentId: "parent-comment-id"
)

let reply = try await commentRepository.createComment(with: options)
showSuccessMessage(reply.commentId)

AmitySocialClient.newCommentRepository()
    .createComment()
    .post(postId = postId)
    .parentId(parentId = commentId)
    .with()
    .text(text = "Replying to this comment")
    .build()
    .send()
    .subscribe(
        { reply -> showSuccessMessage(reply.getCommentId()) },
        { error -> handleGeneralError(error) },
    )

final reply = await AmitySocialClient.newCommentRepository()
    .createComment()
    .post(postId)
    .parentId(commentId)
    .create()
    .text('Replying to this comment')
    .send();

final replyId = reply.commentId;

Powered by

Getting Started

Fundamentals

Social

Chat

Video

Release Notes

Migration Guides

Support

Text Comment

Image Comment

Parameters

Basic Text Comment

Reply to a Comment

Text Comment

Image Comment

Query Comments

Delete Comment

Text Comment

Image Comment

​Parameters

​Basic Text Comment

​Reply to a Comment

​Related Topics

Text Comment

Image Comment

Query Comments

Delete Comment

Parameters

Basic Text Comment

Reply to a Comment

Related Topics