Edit and Delete Messages

Use message management APIs after your app already has the target messageId. The client SDKs expose text-message edits, custom-message edits, and soft deletion. Soft deletion marks a message as deleted and lets message queries or single-message observers reflect that state. It is not a hard-delete or recovery API.

Platform Surface

Operation	TypeScript	iOS	Android	Flutter
Edit text	`MessageRepository.updateMessage(messageId, patch)`	`editTextMessage(withId:_:)`	`editTextMessage(messageId).text(...).build().apply()`	`editTextMessage(messageId).text(...).update()`
Edit custom	`MessageRepository.updateMessage(messageId, patch)`	`editCustomMessage(withId:_:)`	`editCustomMessage(messageId).data(...).build().apply()`	`editCustomMessage(messageId, data).update()`
Soft delete	`MessageRepository.softDeleteMessage(messageId)`	`softDeleteMessage(withId:)`	`softDeleteMessage(messageId)`	`deleteMessage(messageId)`

The Flutter updateMessage(channelId, messageId) builder is deprecated. Use editTextMessage(messageId) or editCustomMessage(messageId, customData) for new integrations.

Parameters

Operation	Parameter	Required	Description
Edit text	`messageId`	Yes	Existing text message ID to update.
Edit text	`text` / `data.text`	Yes	Replacement text content.
Edit text	`tags`	No	Replacement tags where the platform edit builder exposes tags.
Edit text	`metadata`	No	Replacement metadata stored with the message.
Edit custom	`messageId`	Yes	Existing custom message ID to update.
Edit custom	`data` / custom payload	Yes	Replacement JSON-serializable custom payload.
Soft delete	`messageId`	Yes	Message ID to soft-delete.

Edit A Text Message

Update the text body and optional app-owned context for an existing text message.

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

const { data: updatedMessage } = await MessageRepository.updateMessage(
  messageId,
  {
    data: { text: 'Updated text' },
    tags: ['edited'],
    metadata: { source: 'composer' },
  },
);

renderResults(updatedMessage);

try await messageRepository.editTextMessage(
    withId: "message-id",
    "Updated text",
    metadata: ["source": "composer"]
)

showSuccessMessage("Message updated")

val metadata = JsonObject().apply {
    addProperty("source", "composer")
}

val disposable = messageRepository
    .editTextMessage(messageId = messageId)
    .text("Updated text")
    .metadata(metadata)
    .build()
    .apply()
    .subscribe(
        { showSuccessMessage() },
        { error -> handleGeneralError(error) },
    )

final updatedMessage = await AmityChatClient.newMessageRepository()
    .editTextMessage(messageId)
    .text('Updated text')
    .tags(['edited'])
    .metadata({'source': 'composer'})
    .update();

final editedAt = updatedMessage.editedAt;

Edit A Custom Message

Update the JSON-serializable payload for an existing custom message.

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

const { data: updatedMessage } = await MessageRepository.updateMessage(
  messageId,
  {
    data: {
      value: { state: 'confirmed' },
    },
  },
);

renderResults(updatedMessage);

try await messageRepository.editCustomMessage(
    withId: "message-id",
    ["state": "confirmed"]
)

showSuccessMessage("Custom message updated")

val customData = JsonObject().apply {
    addProperty("state", "confirmed")
}

val disposable = messageRepository
    .editCustomMessage(messageId = messageId)
    .data(customData)
    .build()
    .apply()
    .subscribe(
        { showSuccessMessage() },
        { error -> handleGeneralError(error) },
    )

final updatedMessage = await AmityChatClient.newMessageRepository()
    .editCustomMessage(messageId, {'state': 'confirmed'})
    .update();

final editedAt = updatedMessage.editedAt;

Soft-Delete A Message

Soft-delete a message by ID so list and single-message observers can reflect deleted state.

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

const deletedMessage =
  await MessageRepository.softDeleteMessage(messageId);

renderResults(deletedMessage);

try await messageRepository.softDeleteMessage(withId: "message-id")
showSuccessMessage("Message deleted")

val disposable = messageRepository
    .softDeleteMessage(messageId = messageId)
    .subscribe(
        { showSuccessMessage() },
        { error -> handleDeletionError(error) },
    )

await AmityChatClient.newMessageRepository()
    .deleteMessage(messageId);

After Edit Or Delete

Observe the message or query collection again instead of mutating app UI state by hand.
Use editedAt to render edited indicators after an edit.
Use isDeleted to render deleted placeholders or hide deleted messages depending on your product rule.
Pass includeDeleted on query APIs only where the platform exposes that filter.

Send Messages

Create the message before editing or deleting it.

Get a Message

Observe one message after an edit or delete.

Query Messages

Refresh timelines and reply threads.

Powered by

Getting Started

Fundamentals

Social

Chat

Video

Release Notes

Migration Guides

Support

Edit and Delete Messages

Platform Surface

Parameters

Edit A Text Message

Edit A Custom Message

Soft-Delete A Message

After Edit Or Delete

Send Messages

Get a Message

Query Messages

​Platform Surface

​Parameters

​Edit A Text Message

​Edit A Custom Message

​Soft-Delete A Message

​After Edit Or Delete

​Related Topics

Send Messages

Get a Message

Query Messages

Platform Surface

Parameters

Edit A Text Message

Edit A Custom Message

Soft-Delete A Message

After Edit Or Delete

Related Topics