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.
Authorization
Invoke the API with JWT in the header with the following syntax:
auth: {{JWT}}
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"
}