Check Username Availability

This method is planned to be removed by 7.0.0. Use the /users.checkUsernameAvailability endpoint instead.

Confirm if a username is available.

Name

Requires Auth

checkUsernameAvailability

Yes

Payload Parameters

Argument

Example

Required

Description

username

john.wood

Required

The username you are checking for.

Example call

{
    "msg": "method",
    "method": "checkUsernameAvailability",
    "id": "117",
    "params": [
        "funke"
    ]
}

Example Response

{
    "msg": "result",
    "id": "117",
    "result": true
}

Last updated

Rocket.Chat versions receive support for six months after release.