Delete a saved snippet

DELETE https://csdl.zulipchat.com/api/v1/saved_snippets/{saved_snippet_id}

Delete a saved snippet.

Changes: New in Zulip 10.0 (feature level 297).

Usage examples

#!/usr/bin/env python3

import zulip

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

# Delete a saved snippet.
result = client.call_endpoint(
    url=f"/saved_snippets/{saved_snippet_id}",
    method="DELETE",
)
print(result)

curl -sSX DELETE https://csdl.zulipchat.com/api/v1/saved_snippets/2 \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY

Parameters

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 saved snippet exists with the provided ID:

{
    "code": "BAD_REQUEST",
    "msg": "Saved snippet does not exist.",
    "result": "error"
}