This API is used to edit an agent's details in CloudAgent. The user MUST update the ‘action’ parameter with the Edit function.

Prerequisites

To access this API we need to pass the following parameters.

Parameter	Desciption
apiKey*	Available in CloudAgent admin login
userName*	CloudAgent user name
agentName*	Name of the agent
agentId*	Unique agentId to be assigned to agent
agentPassword*	Password for the agent to login
action*	Create: To create a new agent Edit: To update an existing agent Delete: Delete an agent profile
skill	Skill names with comma separation, that are to be assigned to agent while creating
agentIdNew*	agentIdNew parameter can be passed if you want to edit agentId
assignSkill	Skill names with comma separation, that are to be assigned to an agent while updating
unAssignSkill	Skill names with comma separation, that are to be unassigned to an agent while updating

❗️
Note
Parameters with ‘*’ are considered to be mandatory parameters.

Possible Responses

Response	Output
Success Create response	"status": "success" "message": "Agent Created Successfully"
Invalid api_key	"status": "error" "message": "Authentication Failed"
Invalid action	"status": "error" "message": "Agent Option is Invalid"
Invalid username	"status": "error" "message": "Authentication Failed"
Empty fields	"status": "error" "message": "All parameters are mandatory"
Name exists	"status": "error" "message": "Agent Already Exists"

📘
Further Insights
By default, the domain name is https://in1-ccaas-api.ozonetel.com. Please refer here to change based on the need.