Update a Specific Agent

Back to API List To update the details of a particular agent with the given streamId and agentId.

Method	PUT
Endpoint	`https://{{host}}/agentassist/api/v1/public/{{streamId}}/agents/{{agentId}}`
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://platform.kore.ai`	String, required
`streamId`	Bot identifier or Stream identifier. You can get it from the App Settings page.	String, required
`agentId`	The Agent identifier of the particular agent whose details are being retrieved.	String, required

Sample Request

curl --location --request PUT 'https://{{host}}/agentassist/api/v1/public/{{streamId}}/agents/{{agentId}}' \
--header 'accept: application/json' \
--header 'auth: {{JWT_TOKEN}}' \
--header 'accountId: {{accountId}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "firstName": "aug08",
    "lastName": "agent1",
    "fullName": "aug08 agent1",
    "lFullName": "aug08 agent1",
    "emailId": "john.doe@example.com",
    "nickName": "agent One",
    "IsAgentConsoleLanding": true,
    "phoneNumber": "13456*****982",
    "userId": "u-4bd33510-057b-505b-820d-7de70816xxxx",
    "accountId": "67654be356840f366e79xxxx",
    "isAccountOwner": false,
    "orgId": "o-7fc14025-8feb-5b1b-889d-4a689f9dxxxx",
    "customId": "A..Zxyz09!'\'''\'''\''()*+,-./:;<=>?@[]^_`{|}~2222212221212121219",
    "agentGroups": [
        {
            "groupId": "ag-c57b602-151a-41c8-8630-a1eae433xxxx",
            "role": "agent"
        }
    ],
    "canSupportChat": true,
    "canSupportCase": false,
    "canSupportVoiceMail": false,
    "chatLanguageSupport": [
        {
            "language": "en",
            "proficiency": "expert",
            "isActive": true
        }
    ],
    "canSupportVoice": true,
    "voiceLanguageSupport": [
        {
            "language": "en",
            "proficiency": "expert",
            "isActive": true
        }
    ],
    "attachmentsEnabled": true,
    "emojisEnabled": true,
    "createdBy": "u-e454bed4-1f28-5a19-83bb-b29cc237xxxx",
    "status": "ACTIVE",
    "roleId": "67654be356840f366e79xxxx",
    "iId": "st-ceb5fb14-37eb-54a8-a32d-1d751c10xxxx",
    "createdByAId": "a-ca6a70e-32d3-43bb-b7ee-d29995a0xxxx",
    "desktopLayouts": [
        {
            "id": "ly-c118776-315a-4b36-a0dc-00010296xxxx",
            "isDefault": true
        }
    ],
    "maxDigitalChatSupport": 5,
    "maxEmailChatSupport": 5,
    "maxMessagingChatSupport": 5,
    "markedAutoAway": false,
    "dAgentGroups": [],
    "caseLanguageSupport": [],
    "lastOnlineAt": "2025-08-05T06:42:06.414Z",
    "voiceSupport": [],
    "createdAt": "2025-08-05T06:42:06.414Z",
    "updatedAt": "2025-08-05T06:42:06.414Z",
    "id": "a-5892576-bb12-461b-a58a-637d1d21xxxx",
    "agentGroupId": "ag-c57b602-151a-41c8-8630-a1eae433xxxx",
    "queues": [],
    "skills": []
}'

Body Parameters

Parameter	Description	Type
`firstName`	First name of the agent.	String, required
`lastName`	Last name of the agent.	String, required
`fullName`	Full name of the agent (first name + last name).	String, optional
`lFullName`	Localized full name of the agent.	String, optional
`emailId`	Email address of the agent. Must be unique.	String, required
`IsAgentConsoleLanding`	Indicates whether the agent console is configured as the landing page.	Boolean, optional
`nickName`	Nickname of the agent.	String, optional
`phoneNumber`	Contact number of the agent.	String, optional
`userId`	Unique user identifier assigned to the agent.	String, required
`accountId`	Unique identifier of the account.	String, required
`isAccountOwner`	Indicates if the agent is the account owner.	Boolean, optional
`orgId`	Identifier for the organization.	String, required
`customId`	Custom identifier for the agent. Supports special characters except space.	String, optional
`agentGroups`	List of agent groups and roles assigned.	Array, optional
`agentGroups.groupId`	Unique identifier of the agent group.	String, required
`agentGroups.role`	Role of the agent within the group.	String, required
`canSupportChat`	Defines if the agent can handle chat interactions.	Boolean, optional
`canSupportCase`	Defines if the agent can handle case interactions.	Boolean, optional
`canSupportVoiceMail`	Defines if the agent can handle voice mails.	Boolean, optional
`chatLanguageSupport`	List of languages and proficiency levels supported for chat.	Array, optional
`chatLanguageSupport.language`	Language code (for example, `"en"`).	String, required
`chatLanguageSupport.proficiency`	Proficiency level in the language.	String, required
`chatLanguageSupport.isActive`	Indicates if the language is active.	Boolean, optional
`canSupportVoice`	Defines if the agent can handle voice interactions.	Boolean, optional
`voiceLanguageSupport`	List of languages and proficiency levels supported for voice.	Array, optional
`voiceLanguageSupport.language`	Language code (for example, `"en"`).	String, required
`voiceLanguageSupport.proficiency`	Proficiency level in the language.	String, required
`voiceLanguageSupport.isActive`	Indicates if the language is active.	Boolean, optional
`attachmentsEnabled`	Defines if the agent can send/receive attachments.	Boolean, optional
`emojisEnabled`	Defines if the agent can use emojis.	Boolean, optional
`createdBy`	Identifier of the user who created the agent record.	String, optional
`status`	Current status of the agent (for example, `ACTIVE`).	String, optional
`roleId`	Identifier for the role assigned to the agent.	String, required
`iId`	Instance identifier of the agent.	String, required
`createdByAId`	Identifier of the admin who created the agent record.	String, optional
`desktopLayouts`	List of desktop layouts assigned to the agent.	Array, optional
`desktopLayouts.id`	Identifier of the desktop layout.	String, required
`desktopLayouts.isDefault`	Defines if the layout is the default.	Boolean, optional
`maxDigitalChatSupport`	Maximum number of simultaneous digital chats supported.	Integer, optional
`maxEmailChatSupport`	Maximum number of simultaneous email chats supported.	Integer, optional
`maxMessagingChatSupport`	Maximum number of simultaneous messaging chats supported.	Integer, optional
`markedAutoAway`	Indicates if the agent is auto marked away.	Boolean, optional
`dAgentGroups`	Deprecated/unused agent groups.	Array, optional
`caseLanguageSupport`	List of supported languages for case handling.	Array, optional
`lastOnlineAt`	Timestamp of when the agent was last online ISO 8601 format.	String, optional
`voiceSupport`	List of voice support configurations.	Array, optional
`createdAt`	Timestamp when the agent record was created in ISO 8601 format.	String, optional
`updatedAt`	Timestamp when the agent record was last updated in ISO 8601 format.	String, optional
`id`	Unique identifier of the agent.	String, required
`agentGroupId`	Identifier of the default agent group.	String, required
`queues`	List of queues assigned to the agent.	Array, optional
`skills`	List of skills assigned to the agent.	Array, optional

Sample Response

{
  "status": "ACTIVE",
  "agentAffinity": false,
  "canSupportChat": true,
  "maxChatSupport": 5,
  "IsAgentConsoleLanding": true,
  "roleId": "6344eb107b65bd738aa6xxxx",
  "chatLanguageSupport": [
    {
      "isActive": true,
      "language": "en",
      "proficiency": "expert"
    }
  ],
  "canSupportVoice": true,
  "voiceLanguageSupport": [
    {
      "isActive": true,
      "language": "en",
      "proficiency": "expert"
    }
  ],
  "desktopLayouts": [
    {
      "isDefault": true,
      "name": "Default Layout",
      "id": "ly-59736ed-eaac-40d6-8c5b-db294b10xxxx"
    },
    {
      "isDefault": false,
      "name": "test1",
      "id": "ly-2a591ae-5021-4e25-a9be-9997e585xxxx"
    }
  ],
  "userId": "u-cc128d1c-a846-5acb-b075-9fc49a73xxxx",
  "accountId": "633ffa91d784f471d0b8xxxx",
  "createdBy": "u-ca2cc57f-5c2b-5437-bb07-fe9020d8xxx",
  "orgId": "o-f7507858-f354-504a-b56b-39464fb0xxxx",
  "agentGroups": [
    {
      "groupId": "ag-bdc4010-e237-48e6-bb72-d3449a03xxxx",
      "role": "agent"
    }
  ],
  "lastOnlineAt": "2022-10-11T04:06:41.286Z",
  "createdAt": "2022-10-07T10:10:39.231Z",
  "updatedAt": "2022-10-12T10:48:53.418Z",
  "onlineStatus": "Available",
  "onlineStatusType": "AVAILABLE",
  "id": "a-1a36a7e-bb33-4bcc-ab7b-ac337738xxxx",
  "emailId": "john.doe@example.com",
  "firstName": "test",
  "lastName": "agent 01",
  "nickName": "test agent 01",
  "phoneNumber": "9123456xxxx",
  "profImage": "no-avatar",
  "sipURI": "sip:supportdevelopment2xx@52.4.142.1xx:5060",
  "skills": [
    {
      "skillId": "633ffac608f3a0745993xxxx",
      "proficiencyLevel": "expert",
      "userId": "u-cc128d1c-a846-5acb-b075-9fc49a73xxxx",
      "createdBy": "u-ca2cc57f-5c2b-5437-bb07-fe9020d8xxxx",
      "accountId": "633ffa91d784f471d0b8xxxx",
      "orgId": "o-f7507858-f354-504a-b56b-39464fb0xxxx",
      "createdAt": "2022-10-12T10:48:53.468Z",
      "updatedAt": "2022-10-12T10:48:53.468Z",
      "id": "63469b95b63e3c0ed3e3xxxx",
      "name": "Default Skill",
      "skillGroupName": "Default SkillGroup",
      "skillGroupColor": "#D2000D"
    }
  ],
  "queues": [
    {
      "id": "qu-353c014-96bb-4c3e-aebd-87a37927xxxx",
      "name": "Default Queue",
      "description": "queue description",
      "isPreferredAgent": true
    }
  ]
}

Response Parameters

Parameter	Type	Description
`status`	String	Status of the agent.
`agentAffinity`	Boolean	Indicates whether agent affinity is enabled.
`canSupportChat`	Boolean	Indicates whether the agent can handle chat interactions.
`maxChatSupport`	Integer	Maximum number of concurrent chat sessions the agent can handle.
`IsAgentConsoleLanding`	Boolean	Indicates whether the agent console is configured as the landing page.
`roleId`	String	Unique identifier of the role assigned to the agent.
`chatLanguageSupport`	Array	List of languages supported by the agent for chat interactions.
`chatLanguageSupport.isActive`	Boolean	Indicates whether the language is active for chat support.
`chatLanguageSupport.language`	String	Language code supported for chat interactions.
`chatLanguageSupport.proficiency`	String	Agent’s proficiency level in the language.
`canSupportVoice`	Boolean	Indicates whether the agent can handle voice interactions.
`voiceLanguageSupport`	Array	List of languages supported by the agent for voice interactions.
`voiceLanguageSupport.isActive`	Boolean	Indicates whether the language is active for voice support.
`voiceLanguageSupport.language`	String	Language code supported for voice interactions.
`voiceLanguageSupport.proficiency`	String	Agent’s proficiency level in the language.
`desktopLayouts`	Array	List of desktop layouts assigned to the agent.
`desktopLayouts.isDefault`	Boolean	Indicates whether the layout is the default layout.
`desktopLayouts.name`	String	Name of the desktop layout.
`desktopLayouts.id`	String	Unique identifier of the desktop layout.
`userId`	String	Unique identifier of the user associated with the agent.
`accountId`	String	Unique identifier of the account.
`createdBy`	String	Unique identifier of the user who created the agent record.
`orgId`	String	Unique identifier of the organization.
`agentGroups`	Array	List of agent groups associated with the agent.
`agentGroups.groupId`	String	Unique identifier of the agent group.
`agentGroups.role`	String	Role of the agent within the group.
`lastOnlineAt`	String	Date and time when the agent was last online in ISO 8601 format.
`createdAt`	String	Date and time when the agent record was created in ISO 8601 format.
`updatedAt`	String	Date and time when the agent record was last updated in ISO 8601 format.
`onlineStatus`	String	Current online status of the agent.
`onlineStatusType`	String	Internal status type of the agent.
`id`	String	Unique identifier of the agent.
`emailId`	String	Email address of the agent.
`firstName`	String	Agent’s first name.
`lastName`	String	Agent’s last name.
`nickName`	String	Display name or nickname of the agent.
`phoneNumber`	String	Contact phone number of the agent.
`profImage`	String	Profile image associated with the agent.
`sipURI`	String	SIP URI used for voice communication.
`skills`	Array	List of skills assigned to the agent.
`skills.skillId`	String	Unique identifier of the skill.
`skills.proficiencyLevel`	String	Agent’s proficiency level for the skill.
`skills.userId`	String	Unique identifier of the user associated with the skill assignment.
`skills.createdBy`	String	Unique identifier of the user who assigned the skill.
`skills.accountId`	String	Unique identifier of the account associated with the skill.
`skills.orgId`	String	Unique identifier of the organization associated with the skill.
`skills.createdAt`	String	Date and time when the skill assignment was created in ISO 8601 format.
`skills.updatedAt`	String	Date and time when the skill assignment was last updated in ISO 8601 format.
`skills.id`	String	Unique identifier of the skill assignment.
`skills.name`	String	Name of the skill.
`skills.skillGroupName`	String	Name of the skill group to which the skill belongs.
`skills.skillGroupColor`	String	Color code associated with the skill group.
`queues`	Array	List of queues assigned to the agent.
`queues.id`	String	Unique identifier of the queue.
`queues.name`	String	Name of the queue.
`queues.description`	String	Description of the queue.
`queues.isPreferredAgent`	Boolean	Indicates whether the agent is configured as a preferred agent for the queue.

​Path Parameters

​Sample Request

​Body Parameters

​Sample Response

​Response Parameters

Path Parameters

Sample Request

Body Parameters

Sample Response

Response Parameters