Deactivate a user

DELETE https://io.phoebus.de/api/v1/users/{user_id}

Deactivates a user given their user ID.

Usage examples

#!/usr/bin/env python

import zulip

# The user for this zuliprc file must be an organization administrator
client = zulip.Client(config_file="~/zuliprc-admin")

# Deactivate a user given a user ID.
result = client.deactivate_user_by_id(user_id)
print(result)

curl -sSX DELETE https://io.phoebus.de/api/v1/users/12 \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY \
    --data-urlencode 'deactivation_notification_comment=Farewell!
'

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

An example JSON error response when attempting to deactivate the only organization owner in an organization:

{
    "code": "BAD_REQUEST",
    "msg": "Cannot deactivate the only organization owner",
    "result": "error"
}