API Reference

Unsubscribe

Method Name

unsubscribe

Unsubscribe from a list of channels, or all channels.

Parameters

channels array of strings
A list of channels names to unsubscribe from.
If not provided, unsubscribe from all channels.

Response

id string or integer required
result object required
result.remaining_subscriptions array of strings required
A list of channels still subscribed to after the unsubscribe operation.
result.status object required
A mapping of channel ⭢ status.
Successfully unsubscribed channels will have status ok.

Example

{request_example_shell}
{request_example_javascript}
{request_example_python}

The above command returns JSON structured like this:

{response_example_json}