Set Visitor Status

Sets omnichannel visitor's satus

Set Omnichannel visitor's status.

HTTP MethodURLRequires Auth

POST

/api/v1/livechat/visitor.status

no

Body

KeyExample ValueDescription

token*

8s7e9ony6ctl27e1qf8kue

The visitor token.

status*

busy

The status of the visitor.

Example Call

curl --location 'https://writing-demo.dev.rocket.chat/api/v1/livechat/visitor.status' \
--header 'Content-Type: application/json' \
--data '{
    "token": "54fc5544030bcecda0533",
    "status": "busy"
}'

Example Response

{
    "token": "54fc5544030bcecda0533",
    "status": "busy",
    "success": true
}

Last updated

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