Skip to content
Download Beeper

Edit a message

client.messages.update(stringmessageID, MessageUpdateParams { chatID, text } params, RequestOptionsoptions?): MessageUpdateResponse { chatID, messageID, success }
PUT/v1/chats/{chatID}/messages/{messageID}

Edit the text content of an existing message. Messages with attachments cannot be edited.

ParametersExpand Collapse
messageID: string
params: MessageUpdateParams { chatID, text }
chatID: string

Path param: Unique identifier of the chat.

text: string

Body param: New text content for the message

minLength1
ReturnsExpand Collapse
MessageUpdateResponse { chatID, messageID, success }
chatID: string

Unique identifier of the chat.

messageID: string

Message ID.

success: boolean

Whether the message was successfully edited

Edit a message

import BeeperDesktop from '@beeper/desktop-api';

const client = new BeeperDesktop();

const message = await client.messages.update('messageID', {
  chatID: '!NCdzlIaMjZUmvmvyHU:beeper.com',
  text: 'x',
});

console.log(message.chatID);
{
  "chatID": "!signal_adamvy:local-signal.localhost",
  "messageID": "1343993",
  "success": true
}
Returns Examples
{
  "chatID": "!signal_adamvy:local-signal.localhost",
  "messageID": "1343993",
  "success": true
}