{"id":22687,"date":"2019-11-01T11:30:55","date_gmt":"2019-11-01T11:30:55","guid":{"rendered":"https:\/\/developer.kore.ai\/v10-1\/?p=22687"},"modified":"2023-07-19T13:20:26","modified_gmt":"2023-07-19T12:20:26","slug":"update-user-api","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/api-guide\/update-user-api\/","title":{"rendered":"Update User API"},"content":{"rendered":"
\r\n\t
\r\n\t\t
\r\n\t\t\t

To update the user details.<\/p>\n

This API requires JWT generated by an application created only from the Bot Admin Console.
This feature was introduced in ver7.1 of the platform.<\/p>\n\n\n\n\n\n\n\n
Method<\/strong><\/td>\nPUT<\/td>\n<\/tr>\n
Endpoint<\/strong><\/td>\nhttps:\/\/{{host}}\/api\/public\/users<\/code><\/td>\n<\/tr>\n
Content Type<\/strong><\/td>\napplication\/json<\/code><\/td>\n<\/tr>\n
Authorization<\/strong><\/td>\n\n

auth: {{JWT}}<\/code><\/p>\n

See How to generate the JWT Token.<\/a><\/td>\n<\/tr>\n

API Scope<\/strong><\/td>\n\n
    \n
  • Bot Builder: Not Applicable<\/li>\n
  • Admin Console: User Management > User Management<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

      <\/p>\n

    Path Parameters<\/span><\/h2>\n\n\n\n\n
    Parameter<\/th>\nDescription<\/th>\n<\/tr>\n
    host<\/td>\nEnvironment URL, for example, https:\/\/bots.kore.ai<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

      <\/p>\n

    Sample Request<\/span><\/h2>\n
    curl -X PUT \\\r\n  https:\/\/{{host}}\/api\/public\/users \\\r\n  -H 'Content-Type: application\/json' \\\r\n  -H 'auth: YOUR_JWT_ACCESS_TOKEN' \\\r\n  -d '{\r\n    \"users\": [\r\n        {\r\n            \"userInfo\": {\r\n                \"emailId\": \"publicuser2@gmail.com\" \/\/ or \"orgUserId<\/span>\": <orgUserId><\/span>,\r\n                \"firstName\": \"user1\",\r\n                \"lastName\":\"user1\",\r\n                \"companyName\":\"company_name\",\r\n                \"dept\":\"dept\",\r\n                \"companyContactPhone\":\"12334444\",\r\n                \"worknumber\":\"321\",\r\n                \"street\":\"street\",\r\n                \"suiteNo\":\"suite\",\r\n                \"city\":\"city\",\r\n                \"zip\":\"123123\",\r\n                \"state\":\"state\",\r\n                \"country\":\"country\"\r\n            },\r\n            \"groups\": {\r\n                \"addTo\": [\r\n                    \"e-f9c09c08-9310-52ff-b672-570ec7325215\"\r\n                ]\r\n            },\r\n            \"roles\": {\r\n                \"addTo\": [\r\n                    {\r\n                        \"roleId\": \"5d9d8db3x0d54920a8df1e68b\",\r\n                        \"botId\": \"st-b8525f88-6dd3-54a7-8a97-734ecb748733\"\r\n                    }\r\n                ],\r\n                \"removeFrom\": [\r\n                    {\r\n                        \"roleId\": \"5d9d920dabdc1e6e8ec99342\",\r\n                        \"botId\": \"st-16511425-15c5-5cdf-b652-a796db7d134b\"\r\n                    }\r\n                ]\r\n            },\r\n            \"assignBotTasks\": [\r\n               {\r\n                  \"botId\": \"st-xxx-xx-xxx-xxx-xxxx\",\r\n                  \"dialogs\": [\"dg-xxxx-xx-xx-xx-xxxx\"]\r\n                 }\r\n      \t       ],\r\n            \"canCreateBot\": true,\r\n            \"isDeveloper\": true\r\n        }\r\n\t]\r\n}\r\n'<\/pre>\n
     <\/p>\n
    Body Parameters<\/span><\/h2>\n\n\n\n
    Parameter<\/th>\nRequired\/Optional<\/th>\nDescription<\/th>\n<\/tr>\n\n\n\n
    users<\/td>\n<\/td>\n<\/td>\n<\/td>\n<\/td>\nRequired<\/td>\nThe array of details for each user that need to be updated.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    Sub-parameters<\/th>\n<\/th>\n<\/th>\n<\/tr>\n
    \n
    userInfo.emailId<\/p>\n
    or userInfo.orgUserId<\/span><\/p>\n<\/td>\n
    		Required<\/td>\nEmail Ids or the org user id of the user being updated<\/td>\n<\/tr>\n
    userInfo.firstName<\/td>\nOptional<\/td>\nFirst name of the user if needs to be updated<\/td>\n<\/tr>\n
    userInfo.lastName<\/td>\nOptional<\/td>\nLast name of the user if needs to be updated<\/td>\n<\/tr>\n
    userInfo.companyName<\/td>\nOptional<\/td>\nCompany to which the user if needs to be updated<\/td>\n<\/tr>\n
    userInfo.dept<\/td>\nOptional<\/td>\nDepartment to which the user if needs to be updated<\/td>\n<\/tr>\n
    userInfo.companyContactPhone<\/td>\nOptional<\/td>\nContact Phone of the Company to which the user belongs if needs to be updated<\/td>\n<\/tr>\n
    userInfo.worknumber<\/td>\nOptional<\/td>\nWork number of the user if needs to be updated<\/td>\n<\/tr>\n
    userInfo.street<\/td>\nOptional<\/td>\nStreet Address of the user if needs to be updated<\/td>\n<\/tr>\n
    userInfo.suiteNo<\/td>\nOptional<\/td>\nSuite No Address of the user if needs to be updated<\/td>\n<\/tr>\n
    userInfo.city<\/td>\nOptional<\/td>\nCity Address of the user if needs to be updated<\/td>\n<\/tr>\n
    userInfo.zip<\/td>\nOptional<\/td>\nZip Address of the user if needs to be updated<\/td>\n<\/tr>\n
    userInfo.state<\/td>\nOptional<\/td>\nState Address of the user if needs to be updated<\/td>\n<\/tr>\n
    userInfo.country<\/td>\nOptional<\/td>\nCountry Address of the user if needs to be updated<\/td>\n<\/tr>\n
    groups<\/td>\nOptional<\/td>\narray of group ids to which the user needs to be\u00a0addTo<\/em> or\u00a0removeFrom<\/em><\/td>\n<\/tr>\n
    roles<\/td>\nOptional<\/td>\narray of roleId-botId combinations to which the user needs to be\u00a0addTo<\/em> or\u00a0removeFrom<\/em><\/td>\n<\/tr>\n
    assignBotTasks<\/td>\nOptional<\/td>\n\n
    array of bots that have to be assigned to the user. If not present, the current assignment will be retained.<\/p>\n\n\n\n\n\n\n
    botId<\/td>\nId of the Bot to be assigned to the user. If not given, all the previous assigned bots will be unassigned. That is, an entry for “assignBotTasks” without “botId” entry can be used to unassign the Bot tasks to the user.<\/td>\n<\/tr>\n
    dialogs<\/td>\nArray of dialog task ids within the bot that need to be assigned to the user. If not given, all the dialog tasks are assigned<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/td>\n<\/tr>\n
    canCreateBot<\/td>\nOptional<\/td>\nDetermines if the specified users can create bots in their Bot Builder accounts. Set to true or false.
    Default value is “true”.<\/em><\/td>\n<\/tr>\n
    isDeveloper<\/td>\nOptional<\/td>\nDetermines if the specified users can have access to Bot Builder. Set to true or false.
    Default value is “true”.<\/em><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
      <\/p>\n
    Sample Response<\/span><\/h2>\n
      \n
    • \n
        \n
      • For success case:\n
        {\r\n        \"msg\": \"Users are updated Successfully\"\r\n    }<\/pre>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
        <\/div><\/div><\/div><\/div><\/div><\/div><\/div><\/section>\n","protected":false},"excerpt":{"rendered":"To update the user details. This API requires JWT generated by an application created only from the Bot 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 Bot Builder: Not Applicable Admin Console: User...","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[17],"tags":[],"class_list":["post-22687","post","type-post","status-publish","format-standard","hentry","category-api-guide"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/22687","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/comments?post=22687"}],"version-history":[{"count":49,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/22687\/revisions"}],"predecessor-version":[{"id":57979,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/22687\/revisions\/57979"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/media?parent=22687"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/categories?post=22687"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/tags?post=22687"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}