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 under 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 requested user is an account owner of or belongs to one or more accounts.
- The requested user is the bot owner or co-developer for one or more bots.
Query Parameters
| Parameter | Description |
|---|---|
| host | Environment URL, for example, https://bots.kore.ai |
Body Parameters
| Parameter | Description |
|---|---|
| userIds | 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. Post v7.3, you can use the channel user ids also. The following are acceptable values for this field:
|
| botIds | The array of bot Ids from where the user details have to be deleted, for example, [“botId1”, “botId2”] |
| RemoveDataFromAllBots
(optional) |
Determines if the specified users details have to be removed from all the Bots. Set to true or false. |
Authorization
Invoke the API with JWT in the header with the following syntax:
auth: {{JWT}}
Response Content Type
application/json
Sample Request
curl -X POST \
https://{{host}}/api/public/bot/eraseUsersData\
-H 'Content-Type: application/json' \
-H 'auth: YOUR_JWT_ACCESS_TOKEN' \
-d '{
userIds: ["userId1","userId2","userId3"],
botIds: ["botId1","botId2","botId3"]
RemoveDataFromAllBots: true // optional
}'
Sample Response
{
"requestId": "eud-123",
"status"”: "in-progress"
}