zulip/templates/zerver/api/deactivate-user.md

36 lines
685 B
Markdown

# Deactivate a user
{!api-admin-only.md!}
{generate_api_description(/users/{user_id}:delete)}
## 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)}