Skip to main content
PUT
/
api
/
user
/
chat-availability
Update chat availability status
curl --request PUT \
  --url https://your-instance.example.com/api/user/chat-availability \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "isAvailable": true
}
'
{
  "success": true,
  "message": "Chat availability enabled",
  "data": {
    "isAvailable": true,
    "lastStatusChange": "2026-05-20T15:04:01.135Z"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
isAvailable
boolean
required

New availability flag; when set to true the escalation queue is processed and the user becomes eligible for round-robin chat assignment.

Response

Chat availability updated

Returned after PUT /api/user/chat-availability toggles the user's availability flag.

success
enum<boolean>
required
Available options:
true
data
object
required
message
string