顧客データを削除する際に使用されます。

このAPIには、ボット管理者コンソールからのみ作成されたアプリケーションによって生成されたJWTが必要です。このAPIを使用するために、アプリは [ボット分析] の [ユーザーデータを削除] の管理APIスコープを必要とします。

削除 https://{{host}}/api/public/bot/eraseUsersData 注意：この機能は、プラットフォームのバージョン7.1で導入されました。以下の場合、ユーザーの削除は処理されません。

• リクエストされたユーザーは、1つ以上のアカウントのアカウントオーナーである、あるいはアカウントに属しています。
• 要求されたユーザーは、1つ以上のボットのボットオーナーまたは共同開発者です。

クエリパラメータ

本文パラメータ

認証

以下の構文を使用して、JWTをヘッダーに含むAPIを呼び出します。 auth: {{JWT}}

応答のコンテンツタイプ

application/json

サンプルリクエスト

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 }'

サンプル応答

{ "requestId": "eud-123", "status"”: "in-progress" }

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

Body Parameters

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"
}