Add a reaction

client.chats.messages.reactions.add(, , ?): ReactionAddResponse { chatID, messageID, reactionKey, 2 more }

POST/v1/chats/{chatID}/messages/{messageID}/reactions

Add a reaction to an existing message.

ParametersExpand Collapse

messageID: string

params: ReactionAddParams { chatID, reactionKey, transactionID }

chatID: string

Path param: Unique identifier of the chat.

reactionKey: string

Body param: Reaction key to add (emoji, shortcode, or custom emoji key)

minLength1

transactionID?: string

Body param: Optional transaction ID for deduplication and local echo tracking

ReturnsExpand Collapse

ReactionAddResponse { chatID, messageID, reactionKey, 2 more }

chatID: string

Unique identifier of the chat.

messageID: string

Message ID.

reactionKey: string

Reaction key that was added

success: true

Whether the reaction was successfully added

transactionID: string

Transaction ID used for the reaction event

Add a reaction

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

const client = new BeeperDesktop();

const response = await client.chats.messages.reactions.add('messageID', {
  chatID: '!NCdzlIaMjZUmvmvyHU:beeper.com',
  reactionKey: 'x',
});

console.log(response.chatID);

{
  "chatID": "!signal_adamvy:local-signal.localhost",
  "messageID": "1343993",
  "reactionKey": "❤️",
  "success": true,
  "transactionID": "txn_123"
}

Returns Examples

{
  "chatID": "!signal_adamvy:local-signal.localhost",
  "messageID": "1343993",
  "reactionKey": "❤️",
  "success": true,
  "transactionID": "txn_123"
}