Edit Comment

Use comment update APIs when a user edits a comment or replaces its image attachments. The SDK sends the update to the server; permission, ownership, and moderation rules are enforced by the backend and surfaced as SDK errors.

Update Fields

Field	TypeScript	iOS	Android	Flutter
Text	`data: { text }`	`AmityCommentUpdateOptions(text:)`	`.text(...)`	`.text(...)`
Metadata	`metadata`	`metadata`	`.metadata(...)`	`.metadata(...)`
Mentions	`mentionees`	`mentioneesBuilder`	`.mentionUsers(...)`	`.mentionUsers(...)`
Links	`links`	`links`	`.links(...)`	Not exposed on the public update builder
Image attachments	`attachments` payload	`attachments`	`.attachments(...)`	`.attachments(...)`

Upload image files first, then pass the uploaded file IDs to the update API. Passing local file paths to comment update is not supported.

Parameters

Operation	Parameter	Required	Description
Update text	`commentId`	Yes	Comment ID to update.
Update text	`text`	Yes	Replacement text body for the comment.
Update image attachments	`commentId`	Yes	Comment ID to update.
Update image attachments	Uploaded image file ID	Yes	Uploaded image file ID to keep on the comment.
Update optional fields	`metadata`, mentions, links	No	Optional editable fields where the target SDK exposes them.

Update Text

Update text and other editable fields by loading the comment ID and applying the platform-specific update call.

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

const { data: updatedComment } = await CommentRepository.updateComment(
  commentId,
  {
    data: {
      text: "Updated comment text",
    },
  },
);

renderResults(updatedComment);

let options = AmityCommentUpdateOptions(
    text: "Updated comment text"
)

let updatedComment = try await commentRepository.editComment(
    withId: "comment-id",
    options: options
)

showSuccessMessage(updatedComment.commentId)

AmitySocialClient.newCommentRepository()
    .editComment(commentId = commentId)
    .text(text = "Updated comment text")
    .build()
    .apply()
    .subscribe(
        { updatedComment -> showSuccessMessage(updatedComment.getCommentId()) },
        { error -> handleGeneralError(error) }
    )

await AmitySocialClient.newCommentRepository()
    .updateComment(commentId: commentId)
    .text('Updated comment text')
    .build()
    .update();

Update Image Attachments

Set the attachment list to the full list you want the comment to keep. To preserve an existing image, include its uploaded file ID in the update payload.

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

const patch: Parameters<typeof CommentRepository.createComment>[0] = {
  referenceId: postId,
  referenceType: "post",
  data: {
    text: "Updated with an image",
  },
  attachments: [
    {
      type: "image",
      fileId: imageFileId,
    },
  ],
};

const { data: updatedComment } = await CommentRepository.updateComment(
  commentId,
  patch,
);

renderResults(updatedComment);

let options = AmityCommentUpdateOptions(
    text: "Updated with an image",
    attachments: [
        .image(fileId: "uploaded-image-id")
    ]
)

let updatedComment = try await commentRepository.editComment(
    withId: "comment-id",
    options: options
)

showSuccessMessage(updatedComment.commentId)

val imageAttachment = AmityComment.Attachment.IMAGE(
    fileId = fileId,
    image = null
)

AmitySocialClient.newCommentRepository()
    .editComment(commentId = commentId)
    .text(text = "Updated with an image")
    .attachments(imageAttachment)
    .build()
    .apply()
    .subscribe(
        { updatedComment -> showSuccessMessage(updatedComment.getCommentId()) },
        { error -> handleGeneralError(error) }
    )

await AmitySocialClient.newCommentRepository()
    .updateComment(commentId: commentId)
    .text('Updated with an image')
    .attachments([
      CommentImageAttachment(fileId: fileId),
    ])
    .build()
    .update();

Clear Optional Fields

Different SDKs distinguish between “leave this field unchanged” and “replace this field with an empty value.”

Change	Pattern
Leave text unchanged	Do not set the text field in the update options
Remove text from a media comment	Set text to an empty string
Leave attachments unchanged	Do not set the attachments field
Remove all attachments	Set attachments to an empty list where the platform exposes that update shape
Remove metadata	Set metadata to an empty object/dictionary
Remove links	Set links to an empty list where the platform exposes link updates

Notes

For TypeScript image attachment updates, build the attachment payload using the same uploaded-file shape as comment creation.
For iOS, Android, and Flutter, nil / unset attachment fields leave existing attachments unchanged; an explicit empty list removes attachments.
Rebuild mention and link payloads from the edited text before updating a comment.
Handle permission, not-found, and moderation errors from the SDK call rather than relying only on client-side checks.

Powered by

Getting Started

Fundamentals

Social

Chat

Video

Release Notes

Migration Guides

Support

Update Fields

Parameters

Update Text

Update Image Attachments

Clear Optional Fields

Notes

Delete Comment

Query Comments

Image Comment

Text Comment

​Update Fields

​Parameters

​Update Text

​Update Image Attachments

​Clear Optional Fields

​Notes

​Related Topics

Delete Comment

Query Comments

Image Comment

Text Comment

Update Fields

Parameters

Update Text

Update Image Attachments

Clear Optional Fields

Notes

Related Topics