Skip to content

Delete Customer Data Status API

Used to get the status of the Delete Customer Data API request.

Note

This API requires JWT generated by an application created only from the Bot Admin Console. 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
  • Bot Builder: Not Applicable
  • Admin Console: Profile Management > Delete Users Data

Path Parameters

PARAMETER DESCRIPTION
host Environment URL, for example, https://bots.kore.ai
reqId Request Id as generated by the Delete API request.

Sample Request

curl -X GET \
   https://{{host}}/api/public/bot/eraseUsersData/status/{{delete request Id}}\
  -H 'Content-Type: application/json' \
  -H 'auth: YOUR_JWT_ACCESS_TOKEN' \

Sample Response

{
    "_id" : "eud-xxx-xxx-xxx-xxx-xxxxxxx",
    "createdOn" : ISODate("2019-09-26T08:42:53.552Z"),
    "lastUpdatedOn" : ISODate("2019-09-26T08:42:53.972Z"),
    "RemoveDataFromAllBots" : true, // based on request payload
    "response" : [ 
        {
            "userId" : "u-xxxxx-xxx-xxx-xxx-xxxxxxx",
            "status" : "SUCCESS"
        }
    ]
}