Update Agent

Update an Agent

Resource

https://api.infobip.com/ccaas/agents/{agentId}

Path Params

Property name Type
agentId string

 

Body Params

Property name Type Description
displayName string  
status string ACTIVE, BUSY, OFFLINE, AWAY
role string AGENT, SUPERVISOR
enabled boolean TRUE, FALSE

Request Example

					PUT /ccaas/1/agents/97457D13B1FC79AF3C1A1096AE7E77AB HTTP/1.1
Host: api.infobip.com
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Accept: application/json

{
    "displayName": "Angus Young",
    "status": "BUSY",
    "role": "SUPERVISOR",
    "enabled": true
}
					
				

Response

					{
    "id": "97457D13B1FC79AF3C1A1096AE7E77AB",
    "displayName": "Angus Young",
    "status": "BUSY",
    "role": "SUPERVISOR",
    "enabled": true,
    "createdAt": "2019-05-10T07:45:23.777+0000",
    "updatedAt": "2019-05-10T09:53:58.463+0000"
}
					
				
					{
  "statusCode": "ERROR",
  "message": "Invalid id '97457D13B1FC79AF3C1A1096AE7E77AB' given! No such entity exists."
}
					
				
					{
    "statusCode": "ERROR",
    "message": "Required request body is missing or not valid"
}
					
				

Parameters

Property name Type Description
agentId string Required - Agents id to update
displayName string Agent name to be displayed, 255 characters max.
status string Possible agent status (ACTIVE, BUSY, OFFLINE, AWAY).
role string Possible agent role (AGENT, SUPERVISOR).
enabled boolean Possible agent status (TRUE, FALSE).