新しいユーザーエイリアスを作成する

このエンドポイントを使用して、既存の識別されたユーザーに新しいユーザーエイリアスを追加するか、新しい識別されていないユーザーを作成する。

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

既存のユーザーのユーザーエイリアスを追加するには、新しいユーザーエイリアスオブジェクトに external_id を含める必要があります。オブジェクトにexternal_id が存在しても、そのexternal_id を持つユーザーがいない場合、エイリアスはどのユーザーにも追加されない。external_id が存在しない場合、ユーザーは作成されますが、後で識別する必要があります。これは、「Identifying Users」と users/identify エンドポイントを使用して行うことができます。

エイリアスのみの新規ユーザーを作成するには、新規ユーザーエイリアスオブジェクトから external_id を省略する必要があります。ユーザーが作成されたら、/users/track エンドポイントを使用して、エイリアスのみのユーザーに属性、イベント、購入を関連付け、/users/identify エンドポイントを使用して、external_id でユーザーを識別します。

前提条件

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

レート制限

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

要求本文:

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

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

リクエストパラメーター

新しいユーザーエイリアスオブジェクトを指定したエンドポイントリクエスト本文

1
2
3
4
5
{
  "external_id" : (optional, string),
  "alias_name" : (required, string),
  "alias_label" : (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/new' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--data-raw '{
  "user_aliases" :[
    {
      "external_id": "external_identifier",
      "alias_name" : "example_name",
      "alias_label" : "example_label"
    }
  ]
}'

応答

1
2
3
4
5
6
Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY
{
    "aliases_processed": 1,
    "message": "success"
}