Set agent offline reason

PATCH

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

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

OperationId:AgentStatus

Takes an agent offline on every queue they are on, with a reason that is recorded in the agent log and shown as the user's status-message. 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. To log in again, use the login 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. Availability becomes manual. GET /domains/{domain}/agents/{callqueue-agent-id}/status reads the reason back.

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-30 21:07:15

Set agent to single call mode

List queued calls