Remove an emoji reaction

Remove an emoji reaction from a message.

DELETE https://yourZulipDomain.zulipchat.com/api/v1/messages/{message_id}/reactions

Usage examples

#!/usr/bin/env python3

import zulip

# Pass the path to your zuliprc file here.
client = zulip.Client(config_file="~/zuliprc")

# Remove an emoji reaction
request = {
    'message_id': str(message_id),
    'emoji_name': 'octopus',
}

result = client.remove_reaction(request)
print(result)

curl -sSX DELETE https://yourZulipDomain.zulipchat.com/api/v1/messages/41/reactions \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY \
    -d 'emoji_name=octopus'

Arguments

message_id required

Example: 41

The ID of the message from which you want to delete the emoji reaction.


emoji_name optional

Example: "octopus"

Name of the emoji you want to delete from a reaction.

To find an emoji's name, hover over a message to reveal three icons on the right, then click the smiley face icon. Images of available reaction emojis appear. Hover over the emoji you want, and note that emoji's text name.

Ignored if emoji_code is also passed.


emoji_code optional

Example: "1f419"

Alternative to emoji_name for expressing which emoji to remove. An encoded version of the unicode codepoint for the emoji you'd like to remove from the message.

Recommended over using emoji_name for Zulip apps because this more robustly handles changes in the mapping between user-facing names and aliases for emoji (which change from time to time) and their unicode codepoints.


reaction_type optional

Example: "unicode_emoji"

When removing a reaction with a custom emoji, set reaction_type to realm_emoji.


Response

Example response

A typical successful JSON response may look like:

{
    "msg": "",
    "result": "success"
}