{"id":22671,"date":"2019-11-01T10:22:20","date_gmt":"2019-11-01T10:22:20","guid":{"rendered":"https:\/\/developer.kore.ai\/v8-0\/?p=22671"},"modified":"2021-03-25T11:16:12","modified_gmt":"2021-03-25T11:16:12","slug":"delete-customer-data-api","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v8-0\/docs\/bots\/api-guide\/delete-customer-data-api\/","title":{"rendered":"Delete Customer Data API"},"content":{"rendered":"
\r\n\t
\r\n\t\t
\r\n\t\t\t

Used to delete customer data.<\/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 Delete Users Data<\/em>\u00a0under Bot Analytics<\/em>.<\/p>\n

DELETE<\/b> https:\/\/{{host}}\/api\/public\/bot\/eraseUsersData<\/code><\/p>\n

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

Delete User will not be processed if:<\/p>\n

    \n
  • The requested user is an account owner of or belongs to one or more accounts.<\/li>\n
  • The requested user is the bot owner or co-developer for one or more bots.<\/li>\n<\/ul>\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\n\n
    Parameter<\/th>\nDescription<\/th>\n<\/tr>\n
    userIds<\/span><\/td>\nThe array of user Ids whose details have to be deleted, for example, [“userId1”, “userId2”]. Can be user email id or enterprise assigned unique id.\u00a0Post v7.3, you can use the channel user ids also. The following are acceptable values for this field:<\/p>\n
      \n
    • Kore generated ‘user id’ ie. ’email address’ in case of enterprise users and ‘u-id’ for the rest.<\/li>\n
    • Channel_user_id ie. the user identity that the channel has provided to the platform<\/li>\n
    • Both channel_id and channel_user_id\u00a0 where Channel_id refers to the unique identified for each of the supported channels<\/li>\n
    • <\/li>\n<\/ul>\n<\/td>\n<\/tr>\n
    botIds<\/span><\/td>\nThe array of bot Ids from where the user details have to be deleted, for example, [“botId1”, “botId2”]<\/td>\n<\/tr>\n
    RemoveDataFromAllBots<\/span><\/p>\n

    (optional)<\/td>\n

    		Determines if the specified users details have to be removed from all the Bots. Set to true or false.<\/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 POST \\\r\n  https:\/\/{{host}}\/api\/public\/bot\/eraseUsersData<\/span>\\\r\n  -H 'Content-Type: application\/json' \\\r\n  -H 'auth: YOUR_JWT_ACCESS_TOKEN' \\\r\n  -d '{\r\n  \tuserIds: [\"userId1\",\"userId2\",\"userId3\"],\r\n\tbotIds: [\"botId1\",\"botId2\",\"botId3\"]\r\n        RemoveDataFromAllBots: true   \/\/ optional\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
    {\r\n  \"requestId\": \"eud-123\",\r\n  \"status\"\u201d: \"in-progress\"\r\n} \r\n<\/pre>\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":"Used to delete customer data. 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 Delete Users Data\u00a0under Bot Analytics. DELETE https:\/\/{{host}}\/api\/public\/bot\/eraseUsersData NOTE: This feature was introduced in ver7.1 of the platform. Delete User will not be processed if: The...","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-22671","post","type-post","status-publish","format-standard","hentry","category-api-guide"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts\/22671","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=22671"}],"version-history":[{"count":7,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts\/22671\/revisions"}],"predecessor-version":[{"id":23698,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts\/22671\/revisions\/23698"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/media?parent=22671"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/categories?post=22671"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/tags?post=22671"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}