Update public username

PATCH https://z.u1v.ru/api/v1/users/me/public_username

Set or clear the requesting user's public username. Usernames are unique within an organization, case-insensitively, and can be used by clients to construct human-readable profile links.

Pass an empty string to clear the username.

Usage examples

curl -sSX PATCH https://z.u1v.ru/api/v1/users/me/public_username \
    -u EMAIL_ADDRESS:API_KEY \
    --data-urlencode public_username=iago

Parameters

Response

Return values

• public_username: string | null

  The user's updated public username, or null if cleared.

Example response(s)

Changes: As of Zulip 7.0 (feature level 167), if any parameters sent in the request are not supported by this endpoint, a successful JSON response will include an ignored_parameters_unsupported array.

A typical successful JSON response may look like:

{
    "msg": "",
    "public_username": "iago",
    "result": "success"
}