Set agent offline

PATCH

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

Last modified:2026-10-30 21:07:03

OperationId:AgentManual

Takes an agent offline on one call queue, or on every queue with all, without ending their shift. The agent log records Manual, shown as Offline. The request has no body. Any scope in the domain but the read-only ones can call it. Call Center Agent and user scopes act only on their own entries (use ~ as the agent), and a Site Manager on users at its own site. For a reason such as Break or Lunch, use the offline reason action.

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 is accepted and applied shortly after. The action is also written to the agent log, which GET /domains/{domain}/agents/{callqueue-agent-id}/status reads back. Availability becomes manual and no calls are dispatched until the agent logs in again.

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//manual' \
--header 'Authorization: Bearer <token>'

Response Example

202 - Accepted

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

Modified at 2026-10-30 21:07:03

Read agent status

Log agent in