Skip to content

ユーザーを削除する

post

/users/delete

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

1 つのリクエストには、最大 50 個の external_idsuser_aliasesbraze_idsemail_addresses、または phone_numbers を含めることができます。単一のリクエストに含めることができるのは、external_idsuser_aliasesbraze_idsemail_addresses、またはphone_numbersのいずれか1つだけです。

API を使用した一括ユーザ削除では解決できないユースケースがある場合は、ブレーズサポートチーム にお問い合わせください。

前提条件

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

レート制限

2021年9月16日以降に Braze にオンボーディングした顧客の場合、このエンドポイントには、1分あたり20,000リクエストの共有レート制限が適用されます。このレート制限は、API レート制限に記載されているように、/users/alias/new/users/identify、および /users/merge エンドポイントと共有されます。

要求本文:

リクエストパラメーター

パラメーター required データ型 説明
external_ids オプション 文字列の配列 削除する外部識別子。
user_aliases オプション ユーザー別名オブジェクトの配列 削除するユーザーエイリアス
braze_ids オプション 文字列の配列 削除するブレーズユーザー識別子。
email_addresses オプション 文字列の配列 削除するユーザメール。詳細については、電子メールによるユーザーの削除を参照してください。
phone_numbers オプション 文字列の配列 削除するユーザー電話番号。

メールでユーザーを削除する

識別子としてemail が指定された場合、識別子にはさらにprioritization の値が必要となる。prioritization は順序付き配列で、複数のユーザーが見つかった場合、どのユーザーを削除するかを指定する。つまり、複数のユーザーが優先順位に一致する場合、ユーザーの削除は起こらない。

配列に使用できる値は、identifiedunidentifiedmost_recently_updated です。most_recently_updated は、最も最近更新されたユーザーを優先することを意味します。

優先配列には、一度に以下のオプションのうち1つしか存在できません。

  • identified を持つユーザーを優先することである。 external_id
  • unidentified のないユーザーを優先することである。 external_id

例のリクエスト

応答

「このページはどの程度役に立ちましたか?」
New Stuff!