{"id":22673,"date":"2019-11-01T10:23:28","date_gmt":"2019-11-01T10:23:28","guid":{"rendered":"https:\/\/developer.kore.ai\/v10-1\/?p=22673"},"modified":"2022-12-05T12:17:07","modified_gmt":"2022-12-05T12:17:07","slug":"delete-customer-data-status-api","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/api-guide\/delete-customer-data-status-api\/","title":{"rendered":"Delete Customer Data Status API"},"content":{"rendered":"
\r\n\t
\r\n\t\t
\r\n\t\t\t

Used to get the status of the Customer Data Delete<\/a> request.<\/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>\nGET<\/td>\n<\/tr>\n
Endpoint<\/strong><\/td>\nhttps:\/\/{{host}}\/api\/public\/bot\/eraseUsersData\/status\/:reqId<\/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\n
    Parameter<\/th>\nDescription<\/th>\n<\/tr>\n
    host<\/td>\nEnvironment URL, for example, https:\/\/bots.kore.ai<\/td>\n<\/tr>\n
    reqId<\/td>\nRequest Id as generated by the Delete API request.<\/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 Request<\/span><\/h2>\n
    curl -X GET \\\r\n   https:\/\/{{host}}\/api\/public\/bot\/eraseUsersData\/status\/{{delete request Id}}\\\r\n  -H 'Content-Type: application\/json' \\\r\n  -H 'auth: YOUR_JWT_ACCESS_TOKEN' \\\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
    Sample Response<\/span><\/h2>\n
    {\r\n    \"_id\" : \"eud-xxx-xxx-xxx-xxx-xxxxxxx\",\r\n    \"createdOn\" : ISODate(\"2019-09-26T08:42:53.552Z\"),\r\n    \"lastUpdatedOn\" : ISODate(\"2019-09-26T08:42:53.972Z\"),\r\n    \"RemoveDataFromAllBots\" : true, \/\/ based on request payload\r\n    \"response\" : [ \r\n        {\r\n            \"userId\" : \"u-xxxxx-xxx-xxx-xxx-xxxxxxx\",\r\n            \"status\" : \"SUCCESS\"\r\n        }\r\n    ]\r\n}\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 get the status of the Customer Data Delete request. 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 GET Endpoint https:\/\/{{host}}\/api\/public\/bot\/eraseUsersData\/status\/:reqId Content Type application\/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope...","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-22673","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\/22673","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=22673"}],"version-history":[{"count":6,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/22673\/revisions"}],"predecessor-version":[{"id":49632,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/22673\/revisions\/49632"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/media?parent=22673"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/categories?post=22673"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/tags?post=22673"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}