StateResourceRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/StateResourceRequest",
  "title": "StateResourceRequest",
  "properties": {
    "state": {
      "description": "It represents the current state of the user. Can be set to ```Available``` or ```Idle```.",
      "type": "string",
      "example": "Available"
    },
    "auxCodeId": {
      "description": "Auxiliary Codes are status codes which an agent can select in Webex Contact Center Agent Desktop. They are of two types: ```Idle``` and ```Wrap-Up``` codes, and every agent profile must have one of each for the agent to use. Idle codes are used to explain an agent's unavailability to take customer contacts, such as during a lunch break or a meeting. Wrap-up codes indicate the result of customer contacts, such as successful resolution or escalation of the contact. Creating and managing auxiliary codes requires an administrator role and the appropriate cjp:config_write or cjp:config_read scopes, maximum length 36 characters.",
      "type": "string",
      "example": "AXUH3oN12eV-WekpnDpl"
    },
    "lastStateChangeReason": {
      "description": "It represents the reason of the last state change request, maximum length 128 characters.",
      "type": "string",
      "example": "Lunch"
    },
    "agentId": {
      "description": "User for which state change is initiated, maximum length 36 characters.",
      "type": "string",
      "example": "1a80ba23-194b-49af-9b93-074b3ecc852a"
    }
  },
  "required": [
    "state",
    "auxCodeId"
  ],
  "type": "object",
  "description": "Request payload to update an agent state."
}