Deactivate custom emoji
DELETE https://css2024.zulip.aalto.fi/api/v1/realm/emoji/{emoji_name}
Deactivate a custom emoji from
the user's organization.
Users can only deactivate custom emoji that they added themselves except for
organization administrators, who can deactivate any custom emoji.
Note that deactivated emoji will still be visible in old messages, reactions,
user statuses and stream descriptions.
Changes: Before Zulip 8.0 (feature level 190), this endpoint returned an
HTTP status code of 400 when the emoji did not exist, instead of 404.
Usage examples
#!/usr/bin/env python3
import zulip
# Pass the path to your zuliprc file here.
client = zulip.Client(config_file="~/zuliprc")
# Delete a custom emoji.
emoji_name = "my_custom_emoji"
result = client.call_endpoint(f"realm/emoji/{emoji_name}", method="DELETE")
print(result)
curl -sSX DELETE https://css2024.zulip.aalto.fi/api/v1/realm/emoji/green_tick \
-u BOT_EMAIL_ADDRESS:BOT_API_KEY
Parameters
emoji_name string required in path
Example: "green_tick"
The name of the custom emoji to deactivate.
Response
Example response(s)
Changes: As of Zulip 7.0 (feature level 167), if any
parameters sent in the request are not supported by this
endpoint, a successful JSON response will include an
ignored_parameters_unsupported
array.
A typical successful JSON response may look like:
{
"msg": "",
"result": "success"
}
An example JSON response for when no emoji exists with the provided name:
{
"code": "BAD_REQUEST",
"msg": "Emoji 'green_tick' does not exist",
"result": "error"
}