2020-02-14 22:02:24 +01:00
|
|
|
# Deactivate a user
|
|
|
|
|
|
|
|
{!api-admin-only.md!}
|
|
|
|
|
2020-04-28 20:00:46 +02:00
|
|
|
{generate_api_description(/users/{user_id}:delete)}
|
2020-02-14 22:02:24 +01:00
|
|
|
|
|
|
|
## Usage examples
|
|
|
|
|
|
|
|
{start_tabs}
|
|
|
|
{tab|python}
|
|
|
|
|
|
|
|
{generate_code_example(python)|/users/{user_id}:delete|example}
|
|
|
|
|
|
|
|
{tab|curl}
|
|
|
|
|
|
|
|
{generate_code_example(curl)|/users/{user_id}:delete|example}
|
|
|
|
|
|
|
|
{end_tabs}
|
|
|
|
|
|
|
|
## Arguments
|
|
|
|
|
|
|
|
{generate_api_arguments_table|zulip.yaml|/users/{user_id}:delete}
|
|
|
|
|
|
|
|
## Response
|
|
|
|
|
|
|
|
#### Example response
|
|
|
|
|
|
|
|
A typical successful JSON response may look like:
|
|
|
|
|
|
|
|
{generate_code_example|/users/{user_id}:delete|fixture(200)}
|
|
|
|
|
|
|
|
An example JSON error response when attempting to deactivate the only
|
|
|
|
organization administrator:
|
|
|
|
|
|
|
|
{generate_code_example|/users/{user_id}:delete|fixture(400)}
|