Agents

Update Agent in Account

Update an Agent in Account

patch/v1/workspaces/{workspace_id}/agents/{id}

Request

  • Base URL: https://api.oxvo.com
  • URL: https://api.oxvo.com/v1/workspaces/{workspace_id}/agents/{id}
  • Auth: API key in header api_access_token

Path parameters

idinteger required

The ID of the agent to be updated.

Request body

role'agent' | 'administrator' required

Whether its administrator or agent

availability_status'available' | 'busy' | 'offline'

The availability status of the agent.

auto_offlineboolean

Whether the availability status of agent is configured to go offline automatically when away.

Example request

{
  "role": "agent",
  "availability_status": "available",
  "auto_offline": true
}

Response

Success

idinteger
account_idinteger
availability_status'available' | 'busy' | 'offline'

The availability status of the agent computed by OXVO.

auto_offlineboolean

Whether the availability status of agent is configured to go offline automatically when away.

confirmedboolean

Whether the agent has confirmed their email address.

emailstring

The email of the agent

available_namestring

The available name of the agent

namestring

The name of the agent

role'agent' | 'administrator'

The role of the agent

thumbnailstring

The thumbnail of the agent

custom_role_idinteger nullable

The custom role id of the agent

Changes

No recorded changes to this operation across all 1 revision of this API.