Autocomplete Room Name for Team

Autocompletes room name available for conversion to team

HTTP MethodURLRequires Auth

GET

/api/v1/rooms.autocomplete.availableForTeams

Query Parameters

KeyExample ValueDescription

name*

data-loss-prevention

Name of the room.

Example Call

curl --location --request GET 'http://localhost:3000/api/v1/rooms.autocomplete.availableForTeams?name=data-loss-prevention\
--header 'X-Auth-Token: myauth-token' \
--header 'X-User-Id: myuser-name'

Example Response

Success

{
    "items": [
        {
            "_id": "osvTu9BnJuSiC8b8M",
            "name": "data-loss-prevention",
            "fname": "data-loss-prevention",
            "t": "p"
        }
    ],
    "success": true
}

Errors

The following error can occur:

  • Authorization: Requires an authentication token for the request to be made.

{
    "status": "error",
    "message": "You must be logged in to do this."
}

Last updated

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