Skip to main content
PUT
Update Current Agent Availability

Authorizations

Authorization
string
header
required

Basic authentication using base64 encoded API key and secret. Format: Authorization: Basic <base64(api_key:api_secret)>

Body

application/json

Availability status update

status
enum<string>
required

Availability status

Available options:
available,
busy,
away,
offline
source
enum<string>

Origin of the status change. 'user' is a manual change by the agent (default); 'idle' is an automatic idle-detection driven change. Idle transitions do not overwrite manual away states.

Available options:
user,
idle
Example:

"idle"

Response

Agent availability status updated successfully

status
string
Example:

"success"

data
object