Remove a registered device

POST https://chat.zulip.org/api/v1/remove_client_device

Mobile devices use this endpoint to remove their device record registered using POST /register_client_device when the user logs out.

This endpoint is currently not useful for clients other than mobile.

Changes: New in Zulip 12.0 (feature level 470).

Usage examples

#!/usr/bin/env python3

import zulip

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

# Remove a registered device.
request = {"device_id": device_id}
result = client.call_endpoint(url="/remove_client_device", method="POST", request=request)
print(result)

curl -sSX POST https://chat.zulip.org/api/v1/remove_client_device \
    -u EMAIL_ADDRESS:API_KEY \
    --data-urlencode device_id=2

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