Set agent offline reason

PATCH

/domains/{domain}/callqueues/all/agents/{callqueue-agent-id}/{status}

Last modified:2026-10-09 00:27:10

OperationId:AgentStatus

Takes an agent offline on every queue they are on, with a reason: availability becomes manual, and the reason is recorded in the agent log and shown as the user's status-message.

Call Center Agent, Basic User, Advanced User, and Simple User act only on their own agent entries: use ~ as the agent. Site Manager acts on agents who are users at its own site; on a named queue, the queue must be at its site too. Call Center Supervisor, Office Manager, Route Manager, Reseller, and Super User act on any agent in the domain. Office Manager Read-Only and Super User Read Only get 403.

The reasons are Break, Lunch, Meeting, Web, Other, Manual-unavail (Unavailable), and cust1 to cust8, the domain's own reasons. The named reasons are case-sensitive; cust1 to cust8 are accepted in any case and stored lower-case. A cust reason shows the label set in the domain's PORTAL_CALL_QUEUE_STATUS_CUSTOM_<N> configuration, or no message when none is set. A reason applies to every queue, so the path always says all; a reason on a named queue returns 400.

202 means the change was published over the service bus (SBUS), not yet applied. GET /domains/{domain}/agents/{callqueue-agent-id}/status reads the reason back. To log in again, call PATCH .../agents/{callqueue-agent-id}/login.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Responses

🟢202Accepted

application/json

The change was published over the service bus (SBUS) and is applied shortly after: {"code": 202, "message": "Accepted"}.

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

🟠405Method Not Allowed

🔴503Service Unavailable

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH 'https://awqacore01.crexendocloud.com/ns-api/v2/domains//callqueues/all/agents//Break' \
--header 'Authorization: Bearer <token>'

Response Example

202 - Accepted

{
    "code": 202,
    "message": "Accepted"
}

Modified at 2026-10-09 00:27:10

Set agent to single call mode

List queued calls