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

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

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

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

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

alias_labelとalias_nameが既に存在する場合

alias_labelとalias_nameの組み合わせは、ユーザー群全体で一意である必要があります。詳細については、ユーザーエイリアスを参照してください。

alias_labelとalias_nameのペアが既にいずれかのユーザーに存在する場合（同じユーザーか別のユーザーかを問わず）、エンドポイントは成功レスポンスを返します（例："aliases_processed": 1、"message": "success"）。この場合、リクエスト内のユーザーに新しいエイリアスは追加されません。alias_labelとalias_nameのペアが既に使用されているため、リクエストは変更を行わず、該当ユーザーにエイリアスが追加されなかったように見えることがあります。

前提条件

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

レート制限

このエンドポイントには、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"
    }
  ]
}'

応答

同じalias_labelとalias_nameが既にユーザーに存在するためにエイリアスがスキップされた場合でも、レスポンス本文は成功を示すことがあります。詳細については、alias_labelとalias_nameが既に存在する場合を参照してください。

1
2
3
4
{
    "aliases_processed": 1,
    "message": "success"
}