Used to get the status of the Customer Data Delete request.
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 under Bot Analytics.
GET https://{{host}}/api/public/bot/eraseUsersData/status/:reqId
NOTE: This feature was introduced in ver7.1 of the platform.
Query Parameters
Parameter | Description |
---|---|
host | Environment URL, for example, https://bots.kore.ai |
reqId | Request Id as generated by the Delete API request. |
Authorization
Invoke the API with JWT in the header with the following syntax:
auth: {{JWT}}
Response Content Type
application/json
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" } ] }