ユーザーエイリアスの更新

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

ユーザーエイリアスは1リクエストにつき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 に更新される。

前提条件

このエンドポイントを使用するには、users.alias.update パーミッションを持つAPI キーが必要です。

レート制限

For customers who onboarded with Braze on or after September 16, 2021, we apply a shared rate limit of 20,000 requests per minute to this endpoint. This rate limit is shared with the /users/delete, /users/identify, /users/merge, and /users/alias/new endpoints, as documented in API rate limits.

リクエスト本文

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"
    }
  ]
}'