To update a particular agent group with the given Stream Id and Agent Group Id.
Method | PUT |
Endpoint | https://{{host}}/agentassist/api/v1/public/{{streamId}}/agent-groups/{{id}} |
Content Type | application/json |
Authorization | auth: {{JWT}} See How to generate the JWT Token. |
API Scope | SmartAssist Analytics |
Path Parameters
Parameter | Description | Type |
---|---|---|
host | Environment URL, for example, https://smartassist.kore.ai | String, Required |
BotId | BotId or StreamId. You can access it from the General Settings page of the bot. | String, Required |
id | The Agent Group id. | String, Required |
Sample Request
curl --location --request POST \ 'https://{{host}}/agentassist/api/v1/public/{{streamId}}/agent-groups/{{id}}' --header 'auth: {jwt-code}' \ --header 'accountId: {{accountId}}' --header 'Content-Type: application/json' \ --data-raw ' { "name": "US West Coast team", "description": "US west coast team handles west side.", "managers": [ { "userId": "u-cc128d1c-a846-5acb-b075-9fc49a73xxxx", "accessLevel": "full" } ] }'
Headers
- accountId (required): The account ID associated with the API request.
- auth (required): JWT token for authentication.
Body Parameters
Parameter | Description | Type |
---|---|---|
name | Name of the Agent Group up to 50 characters long. | String, Required |
description | Brief description of the agent Group up to 50 characters long. | String, Required |
managers | An Array of Objects with the following details | Required |
userId | The User Id. Example: u-cc128d1c-a846-5acb-b075-9fc49a738a04 |
String, Required |
accessLevel | The access level can be: [full, view] |
String, Required |
Sample Response
{ "name": "US West Coast team", "description": "US west coast team handles west side.", "managers": [ { "userId": "u-cc128d1c-a846-5acb-b075-9fc49a73xxxx", "accessLevel": "full" } ] }