API Reference

Edit Agent Details (Token Authentication)

put
https://{domainname}/ca_apis/updateAgent

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean

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

Body Params
string
required

The username of the account.

string
required

The current agent ID.

string

The updated agent ID.

string

The current name of the agent.

string

The updated name of the agent.

string

The updated email of the agent.

string

The updated password for the agent.

string

The auto-answer mode for the agent.

boolean

Enable inbound calls

boolean

Enable manual dialing

boolean

Enable preview dialing

boolean

Enable progressive dialing

boolean

Enable chat channel

boolean

Enable blended mode

boolean

Enable inbound calls in blended mode

boolean

Enable manual dialing in blended mode

boolean

Enable preview mode in blended setup

boolean

Enable progressive dialing in blended setup

boolean

Enable chat in blended mode

callControls
object
string

Additional agent metadata

string

SIP registration location for the agent

boolean

Enable screen recording for the agent

assignSkills
array of objects
assignSkills
unAssignSkills
array of objects
unAssignSkills
string

Comma-separated list of agent groups to assign

string

Comma-separated list of agent groups to unassign

boolean

Lock the agent (true/false)

Headers
string
required
Response

Updated about 1 month ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago