v1

latestOpenAPI 3.0.02026-07-2449050.9 KB

default

Edit Agent Details

Updates the details of an existing agent, such as name, skills, groups, and other attributes.

put/ca_apis/updateAgent

Query parameters

detailedResponseboolean

Set this parameter to true to receive a detailed success response. Any other value will be ignored by the API.

Headers

Content-Typestring required

Request body

userNamestring required

The username of the account.

agentIdstring required

The current agent ID.

agentIdNewstring

The updated agent ID.

agentNamestring

The current name of the agent.

agentNameNewstring

The updated name of the agent.

emailstring

The updated email of the agent.

passwordstring

The updated password for the agent.

autoAnswerstring

The auto-answer mode for the agent.

inboundboolean

Enable inbound calls

manualboolean

Enable manual dialing

previewboolean

Enable preview dialing

progressiveboolean

Enable progressive dialing

chatboolean

Enable chat channel

blendedboolean

Enable blended mode

blendedInboundboolean

Enable inbound calls in blended mode

blendedManualboolean

Enable manual dialing in blended mode

blendedPreviewboolean

Enable preview mode in blended setup

blendedProgressiveboolean

Enable progressive dialing in blended setup

blendedChatboolean

Enable chat in blended mode

agentDatastring

Additional agent metadata

sipLocationstring

SIP registration location for the agent

screenRecordingboolean

Enable screen recording for the agent

assignAgentGroupsstring

Comma-separated list of agent groups to assign

unAssignAgentGroupsstring

Comma-separated list of agent groups to unassign

lockedboolean

Lock the agent (true/false)

Response

Successful response.