Créer un nouvel alias utilisateur

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

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

L’ajout d’un alias d’utilisateur pour un utilisateur existant nécessite qu’un external_id soit inclus dans le nouvel objet alias d’utilisateur. Si l’external_id est présent dans l’objet mais qu’aucun utilisateur ne possède cet external_id, l’alias ne sera ajouté à aucun utilisateur. En l’absence d’un external_id, un utilisateur sera tout de même créé, mais il devra être identifié ultérieurement. Vous pouvez le faire en utilisant la fonctionnalité « 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 à des attributs, des événements et des achats, et l’endpoint /users/identify pour identifier l’utilisateur avec un external_id.

Lorsque alias_label et alias_name existent déjà

La combinaison de alias_label et alias_name doit être unique dans l’ensemble de votre base d’utilisateurs. Pour plus d’informations, consultez Alias d’utilisateur.

Si vous envoyez une requête dans laquelle la paire alias_label et alias_name existe déjà pour un utilisateur (que ce soit le même utilisateur ou un autre), l’endpoint renvoie tout de même une réponse de succès (par exemple, "aliases_processed": 1, "message": "success"). Dans ce cas, aucun nouvel alias n’est ajouté à l’utilisateur de la requête. Étant donné que la paire alias_label et alias_name est déjà utilisée, la requête n’effectue aucune modification, et il peut sembler que l’alias n’a jamais été ajouté à l’utilisateur en question.

Conditions préalables

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

Limite de débit

Nous appliquons une limite de débit partagée de 20 000 requêtes par minute à cet endpoint. Cette limite de débit est partagée avec les endpoints /users/delete, /users/identify, /users/merge et /users/alias/update, comme documenté dans Limites de débit de l’API.

Corps de la requête

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 requête

Corps de requête de l’endpoint avec spécification de l’objet nouvel alias d’utilisateur

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

Exemple de requête

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

Lorsqu’un alias est ignoré parce que la même combinaison alias_label et alias_name existe déjà pour un utilisateur, le corps de la réponse peut tout de même indiquer un succès. Consultez Lorsque le libellé d’alias et le nom existent déjà pour plus de détails.

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