Skip to content

Update User API

To update the user details.

Note

This API requires JWT generated by an application created only from the Admin Console. This feature was introduced in ver7.1 of the platform.

Method PUT
Endpoint https://{{host}}/api/public/users
Content Type application/json
Authorization auth: {{JWT}}

See How to generate the JWT Token.

API Scope
  • App Builder: Not Applicable
  • Admin Console: User Management > User Management

Path Parameters

PARAMETER DESCRIPTION
host Environment URL, for example, https://platform.kore.ai

Sample Request

curl -X PUT 'https://{{host}}/api/public/users' \
  -H 'Content-Type: application/json' \
  -H 'auth: YOUR_JWT_ACCESS_TOKEN' \
  -d '{
    "users": [
        {
            "userInfo": {
                "emailId": "john.doe@example.com" // or "orgUserId": <orgUserId>,
                "firstName":"john",
                "lastName":"doe",
                "companyName":"company_name",
                "dept":"dept",
                "companyContactPhone":"12334444",
                "worknumber":"321",
                "street":"street",
                "suiteNo":"suite",
                "city":"city",
                "zip":"123123",
                "state":"state",
                "country":"country"
            },
            "groups": {
                "addTo": [
                    "e-f9c09c08-9310-52ff-b672-570ec7325215"
                ]
            },
            "roles": {
                "addTo": [
                    {
                        "roleId": "5d9d8db3x0d54920a8df1e68b",
                        "botId": "st-b8525f88-6dd3-54a7-8a97-734ecb748733"
                    }
                ],
                "removeFrom": [
                    {
                        "roleId": "5d9d920dabdc1e6e8ec99342",
                        "botId": "st-16511425-15c5-5cdf-b652-a796db7d134b"
                    }
                ]
            },
            "assignBotTasks": [
               {
                  "botId": "st-xxx-xx-xxx-xxx-xxxx",
                  "dialogs": ["dg-xxxx-xx-xx-xx-xxxx"]
                 }
               ],
            "canCreateBot": true,
            "isDeveloper": true
        }
    ]
}
'

Body Parameters

PARAMETER REQUIRED/OPTIONAL DESCRIPTION
users Required The array of details for each user that need to be updated.
SUB-PARAMETERS
userInfo.emailId

or userInfo.orgUserId

Required Email Ids or the org user id of the user being updated
userInfo.firstName Optional First name of the user if needs to be updated
userInfo.lastName Optional Last name of the user if needs to be updated
userInfo.companyName Optional Company to which the user if needs to be updated
userInfo.dept Optional Department to which the user if needs to be updated
userInfo.companyContactPhone Optional Contact Phone of the Company to which the user belongs if needs to be updated
userInfo.worknumber Optional Work number of the user if needs to be updated
userInfo.street Optional Street Address of the user if needs to be updated
userInfo.suiteNo Optional Suite No Address of the user if needs to be updated
userInfo.city Optional City Address of the user if needs to be updated
userInfo.zip Optional Zip Address of the user if needs to be updated
userInfo.state Optional State Address of the user if needs to be updated
userInfo.country Optional Country Address of the user if needs to be updated
groups Optional array of group ids to which the user needs to be addTo or removeFrom
roles Optional array of roleId-botId combinations to which the user needs to be addTo or removeFrom
assignBotTasks Optional array of AI agents that have to be assigned to the user. If not present, the current assignment will be retained.
botId Unique Id of the AI Agent to be assigned to the user. If not given, all the previous assigned AI agents will be unassigned. That is, an entry for “assignBotTasks” without “botId” entry can be used to unassign the Bot tasks to the user.
dialogs Array of dialog task ids within the bot that need to be assigned to the user. If not given, all the dialog tasks are assigned
canCreateBot Optional Determines if the specified users can create AI agents in their App Builder accounts. Set to true or false. Default value is _“true”._
isDeveloper Optional Determines if the specified users can have access to App Builder. Set to true or false. Default value is _“true”._

Sample Response

For success case: 

{
        "msg": "Users are updated Successfully"
}