PATCH /users/{email}

Administrative endpoint to update the details of another user in the organization by their email address. Works the same way as PATCH /users/{user_id} but fetching the target user by their real email address.

The requester needs to have permission to view the target user's real email address, subject to the user's email address visibility setting. Otherwise, the dummy address of the format user{id}@{realm.host} needs be used. This follows the same rules as GET /users/{email}.

Changes: New in Zulip 10.0 (feature level 313).

Servers

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

Path parameters

Name	Type	Required	Description
`email`	String	Yes	The email address of the user, specified following the same rules as `GET /users/{email}`.

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
`new_email`	String	No	New email address for the user. Requires the user making the request to be an organization owner and additionally have the `.can_change_user_emails` special permission. Changes: New in Zulip 10.0 (feature level 285).
`full_name`	String	No	The user's full name. Changes: Removed unnecessary JSON-encoding of this parameter in Zulip 5.0 (feature level 106).
`role`	Integer	No	New role for the user. Roles are encoded as: Organization owner: 100 Organization administrator: 200 Organization moderator: 300 Member: 400 Guest: 600 Only organization owners can add or remove the owner role. The owner role cannot be removed from the only organization owner. Changes: New in Zulip 3.0 (feature level 8), replacing the previous pair of `is_admin` and `is_guest` boolean parameters. Organization moderator role added in Zulip 4.0 (feature level 60).
`profile_data[]`	Array	No	An array of objects describing updates to the custom profile field data for the user.
`profile_data[].id`	Integer	Yes	The ID of the custom profile field to update.
`profile_data[].value`		Yes	The new value for the user of the specified custom profile field. If null, then any value already set for the specified custom profile field will be removed.

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.