Set Member Availability

Put a member online, offline, or on a break — for chats, for calls, or both — the same change an admin makes from Settings → Team Members or Calls → Team.

  • scope: chats — chat auto-assignment only (round-robin, team pools, automations). Chats already assigned stay with the member.
  • scope: calls — Lodgestory Voice only: an offline or on-break member is not rung by incoming calls (department queues or direct). Applied to every voice agent the member has (e.g. India and US). A member with no voice agent returns 404.
  • scope: both — chats first, then calls. The chat change always stands; the call outcome is reported in calls.status (applied, partial, not_configured, failed), so check it before assuming calls changed.

breakType (offline only) must match one of your break types (case-insensitive; see GET …/break-types) and is recorded as the status label in reports. Omit it for a plain offline status. Every change is recorded in the member's availability history with your service account as the one who made it.

Disabled members can be taken offline but not brought online (403). Re-sending the status a member already has adds no history entry.

Security:

  • The organisationId in the URL must match the organisation your JWT was issued for — requests for a different organisation fail with 401.
  • Requires CRM_ADMIN, ACCOUNT_OWNER, or CRM_BOT role; other roles receive 403.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Your organisation UUID (returned as org from the /token endpoint).

string
required

The member whose status to change (a user id from GET /api/wp-crm/directory/{organisationId}/users).

Body Params
string
enum
required

chats = chat auto-assignment only, calls = Lodgestory Voice calls only, both = chats and calls in one request (chats applied first; calls reported separately).

Allowed:
boolean
required

true puts the member online (receives auto-assigned chats / incoming calls); false takes them offline or on a break.

string
length ≤ 120

Only when available is false: the break to record, matching one of your organisation's break types (case-insensitive — see GET …/break-types). Omit (or send Offline) for a plain offline status.

Responses

400

Bad request — invalid body, unknown break type, breakType sent with available: true, or (scope calls) every voice agent failed to change

401

Unauthorized — invalid/expired JWT or organisation ID does not match the token

403

Forbidden — role not permitted, or bringing a disabled member online

404

The user is not a member of your organisation, or (scope calls) has no Lodgestory Voice agent

429

Too many requests

500

Internal server error

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