{"id":22671,"date":"2019-11-01T10:22:20","date_gmt":"2019-11-01T10:22:20","guid":{"rendered":"https:\/\/developer.kore.ai\/v9-3\/?p=22671"},"modified":"2022-12-05T12:01:32","modified_gmt":"2022-12-05T12:01:32","slug":"delete-customer-data-api","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v9-3\/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 the Bot Admin Console. <\/br>Note:<\/strong> This feature was introduced in ver7.1 of the platform.<\/p>\n

\n

Note:<\/strong> Delete User will not proceed if the requested user is:<\/p>\n

    \n
  • An account owner or belongs to one or more accounts.<\/li>\n
  • The bot owner or co-developer for one or more bots.<\/li>\n<\/ul>\n<\/div>\n\n\n\n\n\n\n\n
    Method<\/strong><\/td>\nDELETE<\/td>\n<\/tr>\n
    Endpoint<\/strong><\/td>\nhttps:\/\/{{host}}\/api\/public\/bot\/eraseUsersData<\/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: Profile Management > Delete Users Data<\/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

      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\/bot\/eraseUsersData<\/span>\\\r\n  -H 'Content-Type: application\/json' \\\r\n  -H 'auth: YOUR_JWT_ACCESS_TOKEN' \\\r\n  -d '{\r\n  \tuserIds: [\"u-xxxxxxxx-xxxx-xxx-xxxx-xxxxxxxxxxx\",\"u-xxxxxxxx-xxxx-xxx-xxxx-xxxxxxxxxxx\",\"u-xxxxxxxx-xxxx-xxx-xxxx-xxxxxxxxxxx\"],\r\n\tbotIds: [\"st-xxxxxxxx-xxxx-xxx-xxxx-xxxxxxxxxxxx\",\"st-xxxxxxxx-xxxx-xxx-xxxx-xxxxxxxxxxxx\",\"x-xxxxxxxx-xxxx-xxx-xxxx-xxxxxxxxxxxx\"]\r\n        RemoveDataFromAllBots: true   \/\/ optional\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\n\n
      Parameter<\/th>\nDescription<\/th>\n<\/tr>\n
      userIds<\/span><\/td>\n\n
      The 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
      \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\r\n\t
      \r\n\t\t
      \r\n\t\t\t
       <\/p>\n
      Sample Response<\/span><\/h2>\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 the Bot Admin Console. Note: This feature was introduced in ver7.1 of the platform. Note: Delete User will not proceed if the requested user is: An account owner or belongs to one or more accounts. The bot owner or...","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\/v9-3\/wp-json\/wp\/v2\/posts\/22671","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/comments?post=22671"}],"version-history":[{"count":15,"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/posts\/22671\/revisions"}],"predecessor-version":[{"id":49630,"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/posts\/22671\/revisions\/49630"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/media?parent=22671"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/categories?post=22671"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/tags?post=22671"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}