ユーザーエイリアスを更新する

このエンドポイントを使用して、既存のユーザーエイリアスを更新する。

ユーザーエイリアスはリクエストごとに50個まで指定できます。

ユーザーエイリアスを更新するには、alias_label、old_alias_name、new_alias_name をユーザーエイリアスの更新オブジェクトに含める必要があります。alias_label とold_alias_name に関連するユーザーエイリアスがない場合、エイリアスは更新されない。所定の alias_label とold_alias_name が見つかった場合、old_alias_name は new_alias_name に更新されます。

前提条件

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

レート制限

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

要求本文:

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

1
2
3
{
  "alias_updates" : (required, array of update user alias object)
}

リクエストパラメーター

更新ユーザーエイリアスオブジェクト指定のエンドポイントリクエスト本体

1
2
3
4
5
{
  "alias_label" : (required, string),
  "old_alias_name" : (required, string),
  "new_alias_name" : (required, string)
}

例のリクエスト

1
2
3
4
5
6
7
8
9
10
11
12
curl --location --request POST 'https://rest.iad-01.braze.com/users/alias/update' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--data-raw '{
  "alias_updates" :[
    {
      "alias_label": "example_alias_label",
      "old_alias_name" : "example_old_alias_name",
      "new_alias_name" : "example_new_alias_name"
    }
  ]
}'