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

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

リクエストごとに最大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に更新されます。

注

このエンドポイントは、alias_updatesオブジェクトの更新順序を保証するものではありません。

前提条件

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

レート制限

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

リクエスト本文

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