Remove a navigation view

DELETE https://chat.hcics.simtech.uni-stuttgart.de/api/v1/navigation_views/{fragment}

Remove a navigation view.

Changes: New in Zulip 11.0 (feature level 390).

Usage examples

#!/usr/bin/env python3

import zulip

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

# Remove a navigation views
result = client.call_endpoint(
    url=f"navigation_views/{fragment}",
    method="DELETE",
)
print(result)

curl -sSX DELETE https://chat.hcics.simtech.uni-stuttgart.de/api/v1/navigation_views/narrow/is/alerted \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY

Parameters

fragment string required in path

Example: "narrow/is/alerted"

The unique URL hash of the navigation view to be removed.

This also serves as the identifier for the navigation view.


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

A typical failed JSON response for when no navigation view exists with the provided fragment:

{
    "code": "BAD_REQUEST",
    "msg": "Navigation view does not exist.",
    "result": "error"
}