Sign in

v1

latestOpenAPI 3.0.02026-07-2483164186.3 KB
Agent

Set agent ONLINE/OFFLINE

Updates an agent's availability to online or offline. The agent is selected by phone (must match the phone stored on the user profile). Requires Agent Availability to be enabled for the organization. When status changes, an ASSIGNED_AGENT_STATUS_CHANGED webhook may be sent per WhatsApp integration where the user has assigned chats.

post/agent/status

Request body

status'ONLINE' | 'OFFLINE' required

Target availability for the resolved user.

phonestring required

Agent phone number; matched digit-only against User.phone for a user in UserOrganization for this org.

Example request

{
  "phone": "919999999999"
}

Response

Status updated.

successboolean required
previousStatusstring nullable

Prior UserOrganization.status before this update (if any).

Example response

{
  "success": true
}