Go back to the team's view of a widget

DELETE https://runix.chat/api/v1/armada/widgets/{install_id}/{widget}/preference

Put every field of your own view of the widget back to the team's. When you first opened the widget is not part of your view, and is kept. Your clients get an armada_widget_preference event.

Guests and bots cannot use this endpoint.

Changes: New in Zulip 13.0 (feature level ZF-1f71ef).

Usage examples

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

curl -sSX DELETE https://runix.chat/api/v1/armada/widgets/1/gpus/preference \
    -u EMAIL_ADDRESS:API_KEY

Parameters

install_id integer required in path

Example: 1

The ID of the plugin's install.


widget string required in path

Example: "gpus"

The widget's key in the plugin's manifest.


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