mirror of https://github.com/zulip/zulip.git
40 lines
778 B
Markdown
40 lines
778 B
Markdown
|
# Deactivate a user
|
||
|
|
|
||
|
|
{!api-admin-only.md!}
|
||
|
|
|
||
|
|
[Deactivates a
|
||
|
|
user](https://zulipchat.com/help/deactivate-or-reactivate-a-user)
|
||
|
|
given their user ID.
|
||
|
|
|
||
|
|
`DELETE {{ api_url }}/v1/users/{user_id}`
|
||
|
|
|
||
|
|
## 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)}
|