Set agent offline

PATCH

/domains/{domain}/callqueues/{callqueue}/agents/{callqueue-agent-id}/manual

Last modified:2026-09-29 04:37:15

OperationId:AgentManual

Takes an agent offline on one call queue, or on every queue with all, without ending their shift: availability becomes manual and no calls are dispatched until they log in again. The agent log records Manual, shown as Offline.

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.

202 means the change was published over the service bus (SBUS), not yet applied. The action is also written to the agent log, which GET /domains/{domain}/agents/{callqueue-agent-id}/status reads back. PUT on this path does the same as PATCH; other methods return 405. The request has no body. To give a reason such as Break or Lunch, use PATCH /domains/{domain}/callqueues/all/agents/{callqueue-agent-id}/{status} instead.

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/example.com/callqueues/all/agents/1001@example.com/manual' \
--header 'Authorization: Bearer <token>'

Response Example

202 - Accepted

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

Modified at 2026-09-29 04:37:15

Read agent status

Log agent in