DELETE /users/{user_id}

Deactivates a user given their user ID.

Note that any bots controlled by the user will be deactivated before the user; clients that don't want this behavior are expected to prompt the user to adjust the bot's owners before making this API request.

Servers

https://{subdomain}.zulipchat.com/api/v1
{server}/api/v1
https://chat.zulip.org/api/v1

Path parameters

Name	Type	Required	Description
`user_id`	Integer	Yes	The target user's ID.

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/x-www-form-urlencoded"

Query parameters

Name Type Required Description

Name	Type	Required	Description
`actions`		No	Additional actions for the server to perform while deactivating the user. As with the actual deactivation, actions are first applied to any bots controlled by the target user, and then to the target user. Changes: New in Zulip 12.0 (feature level 459).

actions

Additional actions for the server to perform while deactivating the user.

As with the actual deactivation, actions are first applied to any bots controlled by the target user, and then to the target user.

Changes: New in Zulip 12.0 (feature level 459).

Request body fields

Name Type Required Description

Name	Type	Required	Description
`deactivation_notification_comment`	String	No	If not `null`, requests that the deactivated user receive a notification email about their account deactivation. If not `""`, encodes custom text written by the administrator to be included in the notification email. Changes: New in Zulip 5.0 (feature level 135).

deactivation_notification_comment

String

If not null, requests that the deactivated user receive a notification email about their account deactivation.

If not "", encodes custom text written by the administrator to be included in the notification email.

Changes: New in Zulip 5.0 (feature level 135).

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.