POST /users/me/status

Change your status.

A request to this endpoint will only change the parameters passed. For example, passing just status_text requests a change in the status text, but will leave the status emoji unchanged.

Clients that wish to set the user's status to a specific value should pass all supported parameters.

Changes: In Zulip 5.0 (feature level 86), added support for emoji_name, emoji_code, and reaction_type parameters.

Servers

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

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.
`away`	Boolean	No	Whether the user should be marked as "away". Changes: Deprecated in Zulip 6.0 (feature level 148); starting with that feature level, `away` is a legacy way to access the user's `presence_enabled` setting, with `away = !presence_enabled`. To be removed in a future release.

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.