Autocomplete Visitors
- Print
- DarkLight
- PDF
Autocomplete Visitors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/api/v1/livechat/visitors.autocomplete
Autocomplete a visitor's name.
Header parameters
X-Auth-Token
stringRequired
The authToken of the authenticated user.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired
The userId of the authenticated user.
ExamplerbAXPnMktTFbNpwtJ
Query parameters
selector
Required
Enter the exceptions or the conditions that you want to search for. For example, { "exceptions" : [], "conditions" : {"username": "guest-5"}}
Responses
200
Success Example
{
"items": [
{
"_id": "6400be90fa0ed7dd90509300",
"username": "guest-5",
"name": "Jane",
"custom_name": "guest-5 - An agent"
}
],
"success": true
}object
items
Array of object
object
_id
string
username
string
name
string
custom_name
string
success
boolean
400
Bad Request
Example 1
{
"success": false,
"error": "must have required property 'selector' [invalid-params]",
"errorType": "invalid-params"
}object
success
boolean
error
string
errorType
string
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string
Was this article helpful?