{"id":22802,"date":"2019-11-02T12:19:02","date_gmt":"2019-11-02T12:19:02","guid":{"rendered":"https:\/\/developer.kore.ai\/v8-0\/?p=22802"},"modified":"2021-03-25T07:44:56","modified_gmt":"2021-03-25T07:44:56","slug":"delete-user-api","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v8-0\/uncategorised\/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 Bot Admin Console.
\nTo use this API, app needs the Admin API Scope of User Management<\/em> under Security & Control<\/em>.<\/p>\n

DELETE <\/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
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
<\/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 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
<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t
Sample Response<\/span><\/h3>\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 Bot Admin Console. To use this API, app needs the Admin API Scope of User Management under Security & Control. DELETE https:\/\/{{host}}\/api\/public\/users NOTE: This feature was introduced in ver7.1 of the platform. Query Parameters Parameter Description host Environment...","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1],"tags":[],"class_list":["post-22802","post","type-post","status-publish","format-standard","hentry","category-uncategorised"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts\/22802","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/comments?post=22802"}],"version-history":[{"count":3,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts\/22802\/revisions"}],"predecessor-version":[{"id":22887,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts\/22802\/revisions\/22887"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/media?parent=22802"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/categories?post=22802"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/tags?post=22802"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}