Skip to main content
PUT
/
api
/
v1
/
agents
/
me
/
availability
Update Current Agent Availability
curl --request PUT \
  --url http://localhost:8080/api/v1/agents/me/availability \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "available"
}
'
{
  "status": "success",
  "data": {
    "id": 1,
    "created_at": "2025-08-28T10:00:00Z",
    "updated_at": "2025-08-28T10:00:00Z",
    "first_name": "John",
    "last_name": "Doe",
    "email": "[email protected]",
    "type": "agent",
    "availability_status": "online",
    "phone_number_country_code": "US",
    "phone_number": "1234567890",
    "avatar_url": "/avatars/agent1.jpg",
    "enabled": true,
    "last_active_at": "2025-08-28T10:00:00Z",
    "last_login_at": "2025-08-28T10:00:00Z",
    "roles": [
      "admin"
    ],
    "permissions": [
      "conversations:read"
    ],
    "custom_attributes": {},
    "teams": [
      {
        "id": 1,
        "name": "Support Team",
        "emoji": "🛠️"
      }
    ],
    "api_key": "<string>",
    "api_key_last_used_at": "2023-11-07T05:31:56Z"
  }
}

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

Response

Agent availability status updated successfully

​
status
string
Example:

"success"

​
data
object