INinfobip
customer-engagement
conversations
conversation-agents

Update agent

Use this method to update an agent. <a href="https://www.infobip.com/docs/conversations/get-started" target="_blank">More info</a>

put/ccaas/1/agents/{agentId}

Request

  • Base URL
    https://api.infobip.com (the document declares no server; this is the origin it was published from)
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://api.infobip.com/auth/1/oauth2/token
    • or API key in header Authorization
    • or API key in header Authorization
    • or HTTP basic

Path parameters

agentIdstring required

Id of the Agent we want to update.

Request body

displayNamestring

Agent name to be displayed.

status'ACTIVE' | 'BUSY' | 'INVISIBLE' | 'AWAY'

Agent availability.

role'AGENT' | 'SUPERVISOR'

Agent role.

enabledboolean

Agent enabled/disabled toggle.

Example request

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

Response

OK

idstring

Agent ID.

displayNamestring required

Agent name to be displayed.

titlestring
status'ACTIVE' | 'BUSY' | 'INVISIBLE' | 'AWAY'

Agent availability.

availability'ACTIVE' | 'BUSY' | 'INVISIBLE' | 'AWAY'

Agent availability.

role'AGENT' | 'SUPERVISOR'

Agent role.

enabledboolean

Agent enabled/disabled toggle.

createdAtstring date-time

Time stamp when agent is created.

updatedAtstring date-time

Time stamp when agent is last updated.

Example response

{
  "id": "97457D13B1FC79AF3C1A1096AE7E77AB",
  "displayName": "Angus Young",
  "status": "ACTIVE",
  "availability": "BUSY",
  "role": "SUPERVISOR",
  "enabled": true,
  "createdAt": "2019-05-10T09:53:58.463+0000",
  "updatedAt": "2019-05-10T09:53:58.463+0000"
}

Changes

No recorded changes to this operation across all 1 revision of this API.