Update agent

Use this method to update an agent. More info

Please log in to see full path URL. Learn why.

put

/ccaas/1/agents/{agentId}

Authorizations:

Scopes:

conversations:manage

path Parameters

agentId

required

string

Id of the Agent we want to update.

query Parameters

context

required

object

accountId	integer <int64>
invokerType	string Enum: "AGENT" "SYSTEM"
invokerId	string
invokerName	string
userId	integer <int64>

Request Body schema:

application/json

collapse all -

displayName required	string [ 0 .. 255 ] characters Agent name to be displayed.
status required	string Enum: "ACTIVE" "BUSY" "INVISIBLE" "AWAY" Agent availability.
role required	string Default: "AGENT" Enum: "AGENT" "SUPERVISOR" Agent role.
enabled	boolean Default: true Agent enabled/disabled toggle.

Responses

200

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Request samples

Content type

application/json

Copy

Collapse all


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

Response samples

Content type

application/json

Successful response

Copy

Collapse all


{"id": "97457D13B1FC79AF3C1A1096AE7E77AB",
"displayName": "Angus Young",
"status": "INVISIBLE",
"role": "AGENT",
"enabled": true,
"createdAt": "2019-05-10T09:53:58.463+0000",
"updatedAt": "2019-08-21T11:33:52.222+0000"
}

Need assistance

Explore Infobip Tutorials

Encountering issues

Contact our support

What's new? Check out

Release Notes

Unsure about a term? See

Glossary

Research panel

Help shape the future of our products

Learn more

Service status

Privacy documents Terms of use