Mettre à jour l’alias d’utilisateur

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

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

Mettre à jour d’un alias d’utilisateur nécessite que alias_label, old_alias_name et new_alias_name soient compris dans l’objet de mise à jour d’alias d’utilisateur. Si aucun alias d’utilisateur n’est associé au alias_label ni 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.

Conditions préalables

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

Limite de débit

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

Paramètres de demande

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

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