{"id":22687,"date":"2019-11-01T11:30:55","date_gmt":"2019-11-01T11:30:55","guid":{"rendered":"https:\/\/developer.kore.ai\/v8-1\/?p=22687"},"modified":"2021-03-18T11:39:51","modified_gmt":"2021-03-18T11:39:51","slug":"update-user-api","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v8-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 user details.<\/p>\n

This API requires JWT generated by an application created only from Bot Admin Console.
\nTo use this API, app needs the Admin API Scope of User Management<\/em> under Security & Control<\/em>.<\/p>\n

PUT <\/b>https:\/\/{{host}}\/api\/public\/users<\/code><\/p>\n

NOTE: This feature was introduced in ver7.1 of the platform.<\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Query Parameters<\/span><\/h3>\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\r\n\t\t<\/div>\r\n\t<\/div>\r\n
<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Body Parameters<\/span><\/h3>\n\n\n\n\n
Parameter<\/th>\nDescription<\/th>\n<\/tr>\n
users<\/td>\nThe array of details for each user that need to be updated<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
userInfo.emailId<\/p>\n

or userInfo.orgUserId<\/span><\/p>\n

(mandatory)<\/td>\n

Email Ids or the org user id of the user being updated<\/td>\n<\/tr>\n
userInfo.firstName
\n(optional)<\/td>\n		First name of the user if needs to be updated<\/td>\n<\/tr>\n
userInfo.lastName
\n(optional)<\/td>\n		Last name of the user if needs to be updated<\/td>\n<\/tr>\n
userInfo.companyName
\n(optional)<\/td>\n		Company to which the user if needs to be updated<\/td>\n<\/tr>\n
userInfo.dept
\n(optional)<\/td>\n		Department to which the user if needs to be updated<\/td>\n<\/tr>\n
userInfo.companyContactPhone
\n(optional)<\/td>\n		Contact Phone of the Company to which the user belongs if needs to be updated<\/td>\n<\/tr>\n
userInfo.worknumber
\n(optional)<\/td>\n		Work number of the user if needs to be updated<\/td>\n<\/tr>\n
userInfo.street
\n(optional)<\/td>\n		Street Address of the user if needs to be updated<\/td>\n<\/tr>\n
userInfo.suiteNo
\n(optional)<\/td>\n		Suite No Address of the user if needs to be updated<\/td>\n<\/tr>\n
userInfo.city
\n(optional)<\/td>\n		City Address of the user if needs to be updated<\/td>\n<\/tr>\n
userInfo.zip
\n(optional)<\/td>\n		Zip Address of the user if needs to be updated<\/td>\n<\/tr>\n
userInfo.state
\n(optional)<\/td>\n		State Address of the user if needs to be updated<\/td>\n<\/tr>\n
userInfo.country
\n(optional)<\/td>\n		Country Address of the user if needs to be updated<\/td>\n<\/tr>\n
groups
\n(optional)<\/td>\n		array of group ids to which the user needs to be\u00a0addTo<\/em> or\u00a0removeFrom<\/em><\/td>\n<\/tr>\n
roles
\n(optional)<\/td>\n		array of roleId-botId combinations to which the user needs to be\u00a0addTo<\/em> or\u00a0removeFrom<\/em><\/td>\n<\/tr>\n
assignBotTasks
\n(optional)<\/td>\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
\n(optional)<\/td>\n		Determines if the specified users can create bots in their Bot Builder accounts. Set to true or false.
\nDefault value is “true”.<\/em><\/td>\n<\/tr>\n
isDeveloper
\n(optional)<\/td>\n		Determines if the specified users can have access to Bot Builder. Set to true or false.
\nDefault value is “true”.<\/em><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Authorization<\/span><\/h3>\n

Invoke the API with JWT in the header with the following syntax:<\/p>\n

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

<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Response Content Type<\/span><\/h3>\n

application\/json<\/code><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Sample Request<\/span><\/h3>\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\r\n\t\t<\/div>\r\n\t<\/div>\r\n
<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t
Sample Response<\/span><\/h3>\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 user details. This API requires JWT generated by an application created only from Bot Admin Console. To use this API, app needs the Admin API Scope of User Management under Security & Control. PUT https:\/\/{{host}}\/api\/public\/users NOTE: This feature was introduced in ver7.1 of the platform. Query Parameters Parameter Description host Environment URL, for...","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\/v8-1\/wp-json\/wp\/v2\/posts\/22687","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/comments?post=22687"}],"version-history":[{"count":9,"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/posts\/22687\/revisions"}],"predecessor-version":[{"id":23417,"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/posts\/22687\/revisions\/23417"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/media?parent=22687"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/categories?post=22687"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/tags?post=22687"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}