Mettre à jour l’alias d’utilisateur

Utilisez cet endpoint pour mettre à jour les alias d’utilisateur existants.

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

La mise à jour d’un alias d’utilisateur nécessite que alias_label, old_alias_name et new_alias_name soient inclus dans l’objet de mise à jour d’alias d’utilisateur. Si aucun alias d’utilisateur n’est associé au alias_label et au old_alias_name, aucun alias ne sera mis à jour. Si le alias_label et le old_alias_name sont trouvés, le old_alias_name sera mis à jour vers le new_alias_name.

Remarque

Cet endpoint ne garantit pas l’ordre de mise à jour des objets alias_updates.

Conditions préalables

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

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/alias/new, /users/identify et /users/merge, 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
{
  "alias_updates" : (required, array of update user alias object)
}

Paramètres de requête

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

1
2
3
4
5
{
  "alias_label" : (required, string),
  "old_alias_name" : (required, string),
  "new_alias_name" : (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/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"
    }
  ]
}'