Remove a web push subscription

DELETE https://most.archetypal.quest/api/v1/users/me/web_push_subscriptions

Remove a browser Web Push subscription previously registered with POST /users/me/web_push_subscriptions.

Removing an endpoint that is not registered is a successful no-op.

Changes: New in Zulip 13.0 (feature level ZF-16420a).

Usage examples

The -u line implements HTTP Basic authentication. See the Authorization header documentation for how to get those credentials for Zulip users and bots.

curl -sSX DELETE https://most.archetypal.quest/api/v1/users/me/web_push_subscriptions \
    -u EMAIL_ADDRESS:API_KEY \
    --data-urlencode endpoint=https://fcm.googleapis.com/fcm/send/abcdef

Parameters

endpoint string required

Example: "https://fcm.googleapis.com/fcm/send/abcdef"

The push service URL (PushSubscription.endpoint) of the subscription to remove.


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"
}