Crear nuevo alias de usuario

Utiliza este punto final para añadir nuevos alias de usuario para usuarios identificados existentes, o para crear nuevos usuarios no identificados.

Se pueden especificar hasta 50 alias de usuario por solicitud.

Añadir un alias de usuario para un usuario existente requiere incluir un external_id en el nuevo objeto alias de usuario. Si el external_id está presente en el objeto pero no hay ningún usuario con ese external_id, el alias no se añadirá a ningún usuario. Si external_id no está presente, se creará un usuario, pero será necesario identificarlo más tarde. Puedes hacerlo utilizando el punto final “Identificación de usuarios” y el punto final users/identify.

La creación de un nuevo usuario solo de alias requiere que se omita external_id en el nuevo objeto alias de usuario. Una vez creado el usuario, utilice el punto final /users/track para asociar el usuario de solo alias con atributos, eventos y compras, y el punto final /users/identify para identificar al usuario con un external_id.

Requisitos previos

Para utilizar este punto final, necesitarás una clave de API con el permiso users.alias.new.

Límite de velocidad

Aplicamos un límite de velocidad compartido de 20 000 solicitudes por minuto a este punto final. Este límite de velocidad se comparte con los puntos finales /users/delete, /users/identify, /users/merge y /users/alias/update, como se documenta en Límites de velocidad de la API.

Cuerpo de la solicitud

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

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

Parámetros de la solicitud

Cuerpo de la solicitud del punto final con la especificación del nuevo objeto alias de usuario

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

Ejemplo de solicitud

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

Respuesta

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