zulip/templates/zerver/api/deactivate-own-user.md
Suyash Vardhan Mathur d3a3c6898c api docs: Add documentation of deactivate-own-user endpoint.
Currently, there was no markdown page for deactivate-own-user API
endpoint. Created deactivate-own-user.md for the API page and
created a new owner client in test-api to reactivate the client
deactivated during testing.

Also changed endpoint name from deactivate-my-account to
deactivate-own-user, for better consistency with other endpoints.

Fixes #16163.
2021-03-25 01:05:44 -07:00

34 lines
634 B
Markdown

# Deactivate own user
{generate_api_description(/users/me:delete)}
## Usage examples
{start_tabs}
{tab|python}
{generate_code_example(python)|/users/me:delete|example}
{tab|curl}
{generate_code_example(curl)|/users/me:delete|example}
{end_tabs}
## Parameters
{generate_api_arguments_table|zulip.yaml|/users/me:delete}
## Response
#### Example response
A typical successful JSON response may look like:
{generate_code_example|/users/me:delete|fixture(200)}
An example JSON error response when attempting to deactivate the only
organization owner in an organization:
{generate_code_example|/users/me:delete|fixture(400)}