Zulip homepage

API documentation home

Integrations

Interactive bots (beta)

REST API

Messages

Drafts

Streams

Users

Server & organizations

Real-time events

Specialty endpoints

Back to Zulip

Remove alert words

DELETE https://chat.zmt-datalab.de/api/v1/users/me/alert_words

Remove words (or phrases) from the user's set of configured alert words.

Alert words are case insensitive.

Usage examples

  • Python
  • curl

#!/usr/bin/env python3

import zulip

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

# Remove words (or phrases) from the user's set of configured alert words.
word = ["foo"]

result = client.remove_alert_words(word)
print(result)


curl -sSX DELETE https://chat.zmt-datalab.de/api/v1/users/me/alert_words \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY \
    --data-urlencode 'alert_words=["foo"]'

Parameters

alert_words (string)[] required

Example: ["foo"]

An array of strings to be removed from the user's set of configured alert words. Strings that are not in the user's set of alert words are ignored.

Response

Return values

  • alert_words: (string)[]

    An array of strings, where each string is an alert word (or phrase) configured by the user.

Example response(s)

A typical successful JSON response may look like:

{
    "alert_words": [
        "bar",
        "natural",
        "illustrious"
    ],
    "msg": "",
    "result": "success"
}