Delete Customer Data API

This API is used to delete customer data.

Note: Delete User will not proceed if the requested user is:

An account owner or belongs to one or more accounts.
The bot owner or co-developer for one or more bots.

Method	DELETE
Endpoint	`https://{{host}}/api/public/bot/eraseUsersData`
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

Sample Request

curl -X DELETE \
  'https://{{host}}/api/public/bot/eraseUsersData' \
  --header 'Content-Type: application/json' \
  --header 'auth: YOUR_JWT_ACCESS_TOKEN' \
  --data '{
  	"userIds": ["u-xxxxxxxx-xxxx-xxx-xxxx-xxxxxxxxxxx","u-xxxxxxxx-xxxx-xxx-xxxx-xxxxxxxxxxx","u-xxxxxxxx-xxxx-xxx-xxxx-xxxxxxxxxxx"],
	"botIds": ["st-xxxxxxxx-xxxx-xxx-xxxx-xxxxxxxxxxxx","st-xxxxxxxx-xxxx-xxx-xxxx-xxxxxxxxxxxx","x-xxxxxxxx-xxxx-xxx-xxxx-xxxxxxxxxxxx"]
        "RemoveDataFromAllBots": true   // optional
       }'

Body Parameters

Parameter	Description
userIds	The array of user Ids whose details have to be deleted, for example, [“userId1”, “userId2”]. It can be user email id or enterprise assigned unique id. The following are acceptable values for this field: Kore generated ‘user id’ ie. ’email address’ in case of enterprise users and ‘u-id’ for the rest. Channel_user_id ie. the user identity that the channel has provided to the platform Both channel_id and channel_user_id where Channel_id refers to the unique identified for each of the supported channels
botIds	The array of bot Ids from where the user details have to be deleted, for example, [“botId1”, “botId2”]. All the user details provided in the userIds parameter will be deleted from all the bots provided in botIds. This parameter is effective only if RemoveDataFromAllBots parameter is set to false.
RemoveDataFromAllBots (optional)	Determines if the specified users details have to be removed from all the Bots. Set to true or false. This parameter is set to false by default. If it is set to true, the user details provided in userIds parameter will be deleted from all the bots in the organization. Data provided in botIds parameter will be ignored.

Parameter

Description

userIds

The array of user Ids whose details have to be deleted, for example, [“userId1”, “userId2”]. It can be user email id or enterprise assigned unique id. The following are acceptable values for this field:

Kore generated ‘user id’ ie. ’email address’ in case of enterprise users and ‘u-id’ for the rest.
Channel_user_id ie. the user identity that the channel has provided to the platform
Both channel_id and channel_user_id where Channel_id refers to the unique identified for each of the supported channels

botIds

The array of bot Ids from where the user details have to be deleted, for example, [“botId1”, “botId2”].

All the user details provided in the userIds parameter will be deleted from all the bots provided in botIds.
This parameter is effective only if RemoveDataFromAllBots parameter is set to false.

RemoveDataFromAllBots

(optional)

Determines if the specified users details have to be removed from all the Bots. Set to true or false.

This parameter is set to false by default.
If it is set to true, the user details provided in userIds parameter will be deleted from all the bots in the organization. Data provided in botIds parameter will be ignored.

Note: The execution status of this API can be vied by executing Delete Customer Data Status API

Sample Response

{

  "requestId": "eud-123",

  "status"”: "in-progress"

}

On this Page