Post
/api/v1/livechat/visitor.status
Update an Omnichannel visitor's status in their conversations. The new status appears on all of the visitor's conversations, including conversations waiting in the queue. The status saved on the visitor's record doesn't change.
Changelog
| Version | Description |
|---|---|
| 0.74.0 | Added |
Body parameters
Example
{
"token": "54fc5544030bcecda0533",
"status": "busy"
}object
token
string Required
The visitor token.
Example54fc5544030bcecda0533
status
string Required
The visitor's new status. Use online, away, busy, or offline.
Examplebusy
Responses
200
Success Example
{
"token": "54fc5544030bcecda0533",
"status": "busy",
"success": true
}object
token
string
status
string
success
boolean
400
Bad Request
Missing Token
{
"success": false,
"error": "Match error: Missing key 'token'"
}Missing Status
{
"success": false,
"error": "Match error: Missing key 'status'"
}Invalid Visitor Token
{
"success": false,
"error": "[invalid-token]",
"errorType": "invalid-token"
}Invalid Field Type
{
"success": false,
"error": "Match error: Expected string, got number in field token"
}Unknown Body Property
{
"success": false,
"error": "Match error: Unknown key in field department"
}object
success
boolean
error
string
errorType
string