POST /users/{user_id}/status

Administrator endpoint for changing the status of another user.

Changes: Prior to Zulip 12.0 (feature level 473), only bots could not access this API endpoint, regardless of the role of the bot.

New in Zulip 11.0 (feature level 407).

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"

Request body fields

Name	Type	Required	Description
`reaction_type`	String	No	A string indicating the type of emoji. Each emoji `reaction_type` has an independent namespace for values of `emoji_code`. Must be one of the following values: `unicode_emoji` : In this namespace, `emoji_code` will be a dash-separated hex encoding of the sequence of Unicode codepoints that define this emoji in the Unicode specification. `realm_emoji` : In this namespace, `emoji_code` will be the ID of the uploaded custom emoji. `zulip_extra_emoji` : These are special emoji included with Zulip. In this namespace, `emoji_code` will be the name of the emoji (e.g. "zulip"). Changes: New in Zulip 5.0 (feature level 86).
`emoji_code`	String	No	A unique identifier, defining the specific emoji codepoint requested, within the namespace of the `reaction_type`. Changes: New in Zulip 5.0 (feature level 86).
`emoji_name`	String	No	The name for the emoji to associate with this status. Changes: New in Zulip 5.0 (feature level 86).
`status_text`	String	No	The text content of the status message. Sending the empty string will clear the user's status. Note: The limit on the size of the message is 60 Unicode code points.

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.