Remove a channel icon

DELETE https://connect.suryojasvi.com/api/v1/streams/{stream_id}/icon

Remove the channel's picture, so that clients fall back to displaying the channel's color.

Requires the permission to administer the channel.

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

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://connect.suryojasvi.com/api/v1/streams/1/icon \
    -u EMAIL_ADDRESS:API_KEY

Parameters

stream_id integer required in path

Example: 1

The ID of the channel to access.


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

An example JSON response for when the user does not have permission to administer the channel:

{
    "code": "BAD_REQUEST",
    "msg": "You do not have permission to administer this channel.",
    "result": "error"
}