2021-10-07 07:51:46 +00:00
|
|
|
tags:
|
2022-04-05 10:35:49 +00:00
|
|
|
- Agents
|
2021-10-07 07:51:46 +00:00
|
|
|
operationId: update-agent-in-account
|
|
|
|
|
summary: Update Agent in Account
|
|
|
|
|
description: Update an Agent in Account
|
|
|
|
|
security:
|
|
|
|
|
- userApiKey: []
|
|
|
|
|
parameters:
|
|
|
|
|
- in: path
|
|
|
|
|
name: id
|
2021-11-17 13:25:15 +00:00
|
|
|
type: integer
|
2021-10-07 07:51:46 +00:00
|
|
|
required: true
|
|
|
|
|
description: The ID of the agent to be updated.
|
|
|
|
|
- name: data
|
|
|
|
|
in: body
|
|
|
|
|
required: true
|
|
|
|
|
schema:
|
|
|
|
|
type: object
|
2021-11-17 13:25:15 +00:00
|
|
|
required:
|
|
|
|
|
- role
|
2021-10-07 07:51:46 +00:00
|
|
|
properties:
|
2021-11-17 13:25:15 +00:00
|
|
|
role:
|
2021-10-07 07:51:46 +00:00
|
|
|
type: string
|
|
|
|
|
enum: ['agent', 'administrator']
|
|
|
|
|
description: Whether its administrator or agent
|
2021-11-17 13:25:15 +00:00
|
|
|
availability:
|
2021-10-07 07:51:46 +00:00
|
|
|
type: string
|
|
|
|
|
enum: ['available', 'busy', 'offline']
|
2021-11-12 10:47:59 +00:00
|
|
|
description: The availability setting of the agent.
|
2021-10-07 07:51:46 +00:00
|
|
|
auto_offline:
|
|
|
|
|
type: boolean
|
|
|
|
|
description: Whether the availability status of agent is configured to go offline automatically when away.
|
|
|
|
|
responses:
|
|
|
|
|
200:
|
|
|
|
|
description: Success
|
|
|
|
|
schema:
|
|
|
|
|
description: 'The updated agent'
|
|
|
|
|
$ref: '#/definitions/agent'
|
|
|
|
|
404:
|
|
|
|
|
description: Agent not found
|
|
|
|
|
403:
|
2021-11-17 13:25:15 +00:00
|
|
|
description: Access denied
|
