Purpose: Block the defined agent. So, agent won't be selectable for the tasks assignment until someone call Unblock or system (AM) restarted. 

Request URI/v1.0/users/{userIdentifier}/block

Method

POST

ParametersDescription

userIdentifier *
string

(path)

Could be UserId (Guid), Sam, Sid, User's SipUri or UserPrincipalName

Responses

CodeDescription / Example 
200
{
  "Id": "string",
  "SipUri": "string",
  "FirstName": "string",
  "LastName": "string",
  "OrganizationUnitNodeId": "string",
  "Sid": "string",
  "Sam": "string",
  "Upn": "string",
  "Email": "string",
  "IsSelectable": true,
  "PresenceToken": "string",
  "PresenceState": "string",
  "Capabilities": {
    "Im": true,
    "Audio": true,
    "Video": true,
    "DesktopSharing": true,
    "ConversationContext": true
  },
  "IsBlockedByLuwareApi": true,
  "CurrentProfile": "string",
  "DefaultProfile": "string",
  "NotReadyReason": "string",
  "NotSelectableReason": "string",
  "AAConfiguration": "string",
  "NumberOfSimultaneousIm": 0,
  "ConversationAsService": "NoConversations",
  "IsBusySelectable": true,
  "IsBusyInAMeetingSelectable": true,
  "ShowAwayAsOffline": true,
  "BusyOnBusyInACallEnabled": true,
  "CanLoginToRecordingManager": true,
  "RetargetType": "NoRetarget",
  "RetargetSource": "RedirectPSTNCallsOnly",
  "RetargetTo": "string",
  "RetargetPrivateNumber": true,
  "RetargetOnlyIfInDutyProfile": true,
  "RecordingType": "NoRecording",
  "Traits": [
    {
      "TraitNode": "string",
      "Attribute": "string"
    }
  ],
  "Profiles": [
    {
      "Name": "string",
      "Responsibilities": [
        {
          "TraitNode": "string",
          "Responsibility": "string"
        }
      ]
    }
  ],
  "Roles": [
    {
      "OrganizationUnit": "string",
      "Role": "string",
      "Permission": "Deny"
    }
  ]
}
CODE
500
{
  "Error": {
    "Code": "NotInitialized",
    "Message": "string"
  }
}
CODE