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.

Body Params
string
enum
required

Target availability for the resolved user.

Allowed:
string
required

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

Responses

400

Invalid status, or Agent Availability not enabled for the org.

401

Unauthorized

Language
Credentials
Header
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json