ユーザーを削除する
既知のユーザー識別子を指定して任意のユーザープロファイルを削除するには、このエンドポイントを使用します。
1つのリクエストには、最大50個のexternal_ids、user_aliases、braze_ids、email_addresses、またはphone_numbersを含めることができます。単一のリクエストに含めることができるのは、external_ids、user_aliases、braze_ids、email_addresses、またはphone_numbersのいずれか1種類だけです。
API経由のユーザーの一括削除では解決できないユースケースがある場合は、Brazeサポートチームにお問い合わせください。
ユーザープロファイルの削除は元に戻せません。削除アクションはユーザーを完全に削除するため、データに不一致が生じる可能性があります。詳細については、このエンドポイントのリファレンスにある「ユーザープロファイル削除の影響」セクションを参照してください。
トラブルシューティング
成功レスポンスが返されたのにユーザーがまだ表示される
成功レスポンスは、リクエストがキューに追加されたことを示すものであり、削除が完了したことを示すものではありません。削除は通常1秒未満で完了しますが、変更がすべてのキャッシュに反映されるまでに最大5分かかる場合があります。削除直後にダッシュボードでユーザーを検索したり、API経由でユーザーのデータをエクスポートしたりすると、この反映期間中はまだ結果が表示されることがあります。
数分経ってもユーザーが存在する場合は、リクエスト内の識別子がユーザーの実際のプロファイルと一致しているか確認してください。
external_ids配列: 各値がユーザーのexternal IDと完全に一致していることを確認してください。braze_id: ユーザーのbraze_idは、/users/export/idsエンドポイントでユーザーのデータをエクスポートするか、セグメントをCSVにエクスポートすることで確認できます（CSVではbraze_idが「Appboy ID」として表示されます）。- エイリアスのみ、またはメールのみのプロファイル: プロファイルに
external_idがない場合は、外部ユーザーIDが空白というフィルターと既知のメールアドレスまたは電話番号を組み合わせたセグメントを作成し、CSVにエクスポートしてbraze_idを取得してください。
ユーザーが削除されたかどうかを確認するには、削除リクエストで使用したのと同じ識別子タイプを使って/users/export/idsエンドポイントを呼び出します（たとえば、external_ids、braze_id、またはuser_aliasesに値を含めます）。ユーザーが存在しなくなっている場合、レスポンスには"users": []が含まれ、その識別子を一覧表示する"invalid_user_ids"が含まれることもあります。
OpenAPIドキュメントをダウンロードして、スキーマの検証に使用できます。方法については、リクエスト検証にOpenAPIスキーマを使用するを参照してください。