Check public username availability

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

Check whether a public username is valid and available for the requesting user. The requesting user's current username is considered available.

Usage examples

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

Parameters

Response

Return values

• public_username: string | null

  The normalized username being checked.

• available: boolean

  Whether the username is available to the requesting user.

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:

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