Delete an event queue


Delete a previously registered queue.

Usage examples

#!/usr/bin/env python3

import zulip

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

# Delete a queue, where `queue_id` is the ID of the queue
# to be removed.
result = client.deregister(queue_id)

More examples and documentation can be found here.

const zulipInit = require("zulip-js");

// Pass the path to your zuliprc file here.
const config = { zuliprc: "zuliprc" };

(async () => {
    const client = await zulipInit(config);

    // Register a queue
    const queueParams = {
        event_types: ["message"],
    const res = await client.queues.register(queueParams);

    // Delete a queue
    const deregisterParams = {
        queue_id: res.queue_id,

    console.log(await client.queues.deregister(deregisterParams));

curl -sSX DELETE \
    --data-urlencode queue_id=fb67bf8a-c031-47cc-84cf-ed80accacda8


queue_id string required

Example: "fb67bf8a-c031-47cc-84cf-ed80accacda8"

The ID of an event queue that was previously registered via POST /api/v1/register (see Register a queue).


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 JSON response for when the queue_id is non-existent or the associated queue has already been deleted:

    "code": "BAD_EVENT_QUEUE_ID",
    "msg": "Bad event queue ID: fb67bf8a-c031-47cc-84cf-ed80accacda8",
    "queue_id": "fb67bf8a-c031-47cc-84cf-ed80accacda8",
    "result": "error"