ユーザーを削除する

既知のユーザー識別子を指定してユーザープロファイルを削除するには、このエンドポイントを使用します。

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 サポートチームにお問い合わせください。

前提条件

このエンドポイントを使用するには、users.delete 権限を持つAPIキーが必要です。

レート制限

このエンドポイントには、1分あたり20,000リクエストの共有レート制限が適用されます。このレート制限は、APIレート制限に記載されているように、/users/alias/new、/users/identify、/users/merge、および /users/alias/update エンドポイントと共有されます。

リクエスト本文

1
2
Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY

1
2
3
4
5
6
7
{
  "external_ids" : (optional, array of string) External IDs to be deleted,
  "user_aliases" : (optional, array of user alias objects) User aliases to be deleted,
  "braze_ids" : (optional, array of string) Braze user identifiers to be deleted,
  "email_addresses": (optional, array of string) User emails to be deleted,
  "phone_numbers": (optional, array of string) User phone numbers to be deleted
}

リクエストパラメーター

メールアドレスと電話番号によるユーザーの削除

メールアドレスまたは電話番号が識別子として指定されている場合、識別子に追加のprioritization値が必要です。prioritizationは順序付けされた配列である必要があり、複数のユーザーが一致する場合に削除するユーザーを指定します。つまり、優先順位に一致するユーザーが複数いる場合、ユーザーの削除は実行されません。

配列に指定できる値は次のとおりです。

• identified
• unidentified
• most_recently_updated（最近更新されたユーザーを優先することを意味します）

prioritization配列には、一度に次のオプションのいずれか1つのみを含めることができます。

• identifiedはexternal_idを持つユーザーを優先することを意味します
• unidentifiedはexternal_idを持たないユーザーを優先することを意味します

リクエスト例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
curl --location --request POST 'https://rest.iad-01.braze.com/users/delete' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--data-raw '{
  "external_ids": ["external_identifier1", "external_identifier2"],
  "braze_ids": ["braze_identifier1", "braze_identifier2"],
  "user_aliases": [
    {
      "alias_name": "user_alias1", "alias_label": "alias_label1"
    },
    {
      "alias_name": "user_alias2", "alias_label": "alias_label2"
    }
  ],
  "email_addresses": [
    {
      "email": "john.smith@braze.com",
      "prioritization": ["unidentified", "most_recently_updated"]
    }
  ]
}'

応答

1
2
3
{
  "deleted" : (required, integer) number of user IDs queued for deletion
}

トラブルシューティング

成功応答が返されたがユーザーがまだ表示される

成功応答はリクエストがキューに入れられたことを確認するものであり、削除が完了したことを意味するものではありません。削除は通常1秒以内に完了しますが、すべてのキャッシュに変更が反映されるまでに最大5分かかる場合があります。削除直後にダッシュボードでユーザーを検索したり、APIを経由してデータをエクスポートしたりすると、この反映時間枠中はまだ結果が表示される場合があります。

数分経ってもユーザーがまだ存在する場合は、リクエスト内の識別子がユーザーの実際のプロファイルと一致しているか確認してください。

• external_ids配列: 各値がユーザーのexternal IDと正確に一致していることを確認してください。
• braze_id: ユーザーのbraze_idは、/users/export/idsエンドポイントでデータをエクスポートするか、SegmentをCSVにエクスポートすることで確認できます（braze_idは「Appboy ID」として表示されます）。
• エイリアスのみまたはメールのみのプロファイル: プロファイルにexternal_idがない場合は、External User IDが空白でフィルターし、既知のメールまたは電話番号と組み合わせたSegmentを作成してから、CSVにエクスポートしてbraze_idを取得してください。

ユーザーが削除されたかどうかを確認するには、削除リクエストで使用したのと同じ識別子タイプを使用して/users/export/idsエンドポイントを呼び出します（例えば、external_ids、braze_id、またはuser_aliasesに値を含めます）。ユーザーが存在しなくなった場合、応答には"users": []が含まれ、その識別子をリストする"invalid_user_ids"が含まれる場合があります。