Créer un nouvel alias utilisateur

Utilisez cet endpoint pour ajouter de nouveaux alias utilisateur pour les utilisateurs identifiés existants, ou pour créer de nouveaux utilisateurs non identifiés.

Vous pouvez spécifier jusqu’à 50 alias de l’utilisateur par requête.

L’ajout d’un alias d’utilisateur pour un utilisateur existant nécessite qu’une adresse external_id soit incluse dans le nouvel objet alias d’utilisateur. Si un external_id indiqué dans l’objet qu’aucun utilisateur ne possède cet external_id, l’alias ne sera ajouté à aucun utilisateur. Faute d’un external_id, un utilisateur sera créé quand même, mais il devra être identifié ultérieurement. Vous pouvez le faire en utilisant l’« identification des utilisateurs » et l’endpoint users/identify.

La création d’un nouvel utilisateur alias uniquement nécessite que l’external_id soit omis du nouvel objet Alias d’utilisateur. Une fois l’utilisateur créé, utilisez l’endpoint /users/track pour associer l’utilisateur alias uniquement aux attributs, événements et achats, et l’endpoint /users/identify pour identifier l’utilisateur avec un external_id.

Conditions préalables

Pour utiliser cet endpoint, vous aurez besoin d’une clé API avec l’autorisation users.alias.new.

Limite de débit

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/update endpoints, as documented in API rate limits.

Corps de la demande

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

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

Paramètres de demande

Corps de demande d’endpoint avec spécification de l’objet Nouvel alias utilisateur

1
2
3
4
5
{
  "external_id" : (optional, string),
  "alias_name" : (required, string),
  "alias_label" : (required, string)
}

Exemple de demande

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

Réponse

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