external IDの名前を変更する

このエンドポイントを使用して、ユーザーのexternal IDの名前を変更します。

1回のリクエストで最大50個の名前変更オブジェクトを送信できます。

このエンドポイントは、ユーザーに新しい（プライマリ）external_idを設定し、既存のexternal_idを非推奨にします。つまり、非推奨のIDが削除されるまでは、どちらのexternal_idでもユーザーを識別できます。複数のexternal IDを持つことで移行期間を設けられるため、以前のexternal ID命名スキーマを使用しているレガシーバージョンのアプリが動作しなくなるのを防げます。移行期間中、プロファイルはどちらの識別子でも完全に機能します。Braze SDK、REST API、メッセージングパイプラインは、非推奨のIDが明示的に削除されるまで、どちらのIDでもユーザーを参照し続けることができます。

古い命名スキーマが使用されなくなった後は、/users/external_ids/removeエンドポイントを使用して非推奨のexternal IDを削除することを強く推奨します。

警告

非推奨のexternal IDは、/users/deleteではなく/users/external_ids/removeエンドポイントを使用して削除してください。非推奨のexternal IDを指定して/users/deleteにリクエストを送信すると、ユーザープロファイルが完全に削除され、元に戻すことはできません。