{"id":22802,"date":"2019-11-02T12:19:02","date_gmt":"2019-11-02T12:19:02","guid":{"rendered":"https:\/\/developer.kore.ai\/v10-1\/?p=22802"},"modified":"2022-12-05T08:00:51","modified_gmt":"2022-12-05T08:00:51","slug":"delete-user-api","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/api-guide\/delete-user-api\/","title":{"rendered":"Remove Users from Account"},"content":{"rendered":"
\r\n\t
\r\n\t\t
\r\n\t\t\t

To remove users from an account.<\/p>\n

This API requires JWT generated by an application created only from the Bot Admin Console. <\/br>Note:<\/strong> This feature was introduced in ver7.1 of the platform.<\/p>\n\n\n\n\n\n\n\n
Method<\/strong><\/td>\nDELETE<\/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\r\n\t\t<\/div>\r\n\t<\/div>\r\n\r\n\t

    \r\n\t\t
    \r\n\t\t\t

     <\/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 DELETE \\\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     \"deleteEmailIds\"\/\"orgUserIds<\/span>\":[\"deskkore1@gmail.com\"]\r\n   }'<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n\r\n\t
    \r\n\t\t
    \r\n\t\t\t
     <\/p>\n
    Body Parameters<\/span><\/h2>\n\n\n\n\n
    Parameter<\/th>\nDescription<\/th>\n<\/tr>\n
    \n
    deleteEmailIds<\/p>\n
    or orgUserIds<\/span><\/td>\n
    		The array of email or org user ids for each user whose information is to be deleted<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n\r\n\t
    \r\n\t\t
    \r\n\t\t\t
     <\/p>\n
    Sample Response<\/span><\/h2>\n
      \n
    • For success case:\n
      {\"msg\": \"Users are removed Successfully\"};\r\n<\/pre>\n<\/li>\n
    • Failure case:\n
          {\r\n    \"failedUserDetails\": [\r\n        {\r\n            \"emailId\": \"deskkore1@gmail.com\",\r\n            \"reason\": {\r\n                \"statusCode\": 400,\r\n                \"status\": 400,\r\n                \"customCode\": 400,\r\n                \"errors\": [\r\n                    {\r\n                        \"msg\": \"Unauthorized to perform this activity\",\r\n                        \"code\": 400\r\n                    }\r\n                ],\r\n                \"_headers\": {},\r\n                \"message\": \"Unauthorized to perform this activity\",\r\n                \"name\": \"BadRequest\"\r\n            }\r\n        }\r\n    ]\r\n}\r\n<\/pre>\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 remove users from an account. This API requires JWT generated by an application created only from the Bot Admin Console. Note: This feature was introduced in ver7.1 of the platform. Method DELETE 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...","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-22802","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\/22802","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=22802"}],"version-history":[{"count":8,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/22802\/revisions"}],"predecessor-version":[{"id":49616,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/22802\/revisions\/49616"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/media?parent=22802"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/categories?post=22802"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/tags?post=22802"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}