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

Base URL
https://public.doubletick.io
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/doubletick/apis/doubletick-public-apis/docs/agent/status/post.ts
A function with typed inputs. Its response is checked against the schema.

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
}

Changes

No recorded changes to this operation across all 1 revision of this API.