Edit Agent Details (Basic Authentication)

put

https://{domainname}/ca_apis/updateAgent

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

Query Params

detailedResponse

boolean

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

Body Params

userName

string

required

The username of the account.

agentId

string

required

The current agent ID.

agentIdNew

string

The updated agent ID.

agentName

string

The current name of the agent.

agentNameNew

string

The updated name of the agent.

string

The updated email of the agent.

password

string

The updated password for the agent.

autoAnswer

string

The auto-answer mode for the agent.

inbound

boolean

Enable inbound calls

manual

boolean

Enable manual dialing

preview

boolean

Enable preview dialing

progressive

boolean

Enable progressive dialing

chat

boolean

Enable chat channel

blended

boolean

Enable blended mode

blendedInbound

boolean

Enable inbound calls in blended mode

blendedManual

boolean

Enable manual dialing in blended mode

blendedPreview

boolean

Enable preview mode in blended setup

blendedProgressive

boolean

Enable progressive dialing in blended setup

blendedChat

boolean

Enable chat in blended mode

callControls

object

agentData

string

Additional agent metadata

sipLocation

string

SIP registration location for the agent

screenRecording

boolean

Enable screen recording for the agent

assignSkills

array of objects

assignSkills

unAssignSkills

array of objects

unAssignSkills

assignAgentGroups

string

Comma-separated list of agent groups to assign

unAssignAgentGroups

string

Comma-separated list of agent groups to unassign

locked

boolean

Lock the agent (true/false)

Headers

apiKey

string

required

Content-Type

string

required

Response

Language

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response.