visitor-autocomplete.md

Visitor Autocomplete

Autocomplete a visitor's name.

HTTP Method	URL	Requires Auth
GET	/api/v1/livechat/visitors.autocomplete	yes

Query Parameters

Key	Example Value	Description
selector*	{ "exceptions" : [], "conditions" : {"username": "guest-5"}}	Enter the exceptions or the conditions that you want to search for.

Example Call

{% code overflow="wrap" %}

curl --location --request GET 'http://localhost:3000/api/v1/livechat/visitors.autocomplete?selector={%20%22exceptions%22%3A%20[{}]%2C%20%22conditions%22%3A%20{%22username%22%3A%20%22guest-5%22}%20}' \
--header 'X-Auth-Token: Y97tM4GkYjgaH_fIO5d' \
--header 'X-User-Id: CkCPNcvsvCDfmWLqC'

{% endcode %}

Example Response

{
    "items": [
        {
            "_id": "6400be90fa0ed7dd90509300",
            "username": "guest-5",
            "name": "Jane",
            "custom_name": "guest-5 - An agent"
        }
    ],
    "success": true
}