Identificar usuarios

Utiliza este punto final para identificar a un usuario no identificado (sólo alias, sólo correo electrónico o sólo número de teléfono) utilizando el ID externo proporcionado.

Cómo funciona

La llamada a /users/identify combina un perfil de usuario que está identificado por un alias (perfil de sólo alias), una dirección de correo electrónico (perfil de sólo correo electrónico) o un número de teléfono (perfil de sólo número de teléfono) con un perfil de usuario que tiene un external_id (perfil identificado), y luego elimina el perfil de sólo alias.

Para identificar a un usuario es necesario incluir un external_id en el objeto aliases_to_identify o emails_to_identify o phone_numbers_to_identify. Si no hay ningún usuario con ese external_id, el external_id se añadirá al registro del usuario aliaseado, y éste se considerará identificado.

Toma nota de lo siguiente:

• Cuando estas asociaciones posteriores se realizan con el campo merge_behavior configurado como none, sólo se conservan los tokens de notificaciones push y el historial de mensajes asociados al alias de usuario; cualquier atributo, evento o compra quedará “huérfano” y no estará disponible para el usuario identificado. Una solución consiste en exportar los datos del usuario alias antes de la identificación mediante el punto final/users/export/ids , y luego volver a asociar los atributos, eventos y compras con el usuario identificado.
• Cuando se realizan asociaciones con el campo merge_behavior configurado como merge, este punto final fusionará campos específicos encontrados en el usuario anónimo con el usuario identificado.
• Los usuarios sólo pueden tener un alias para una etiqueta concreta. Si ya existe un usuario con la dirección external_id y tiene un alias con la misma etiqueta que el perfil de sólo alias, los perfiles de usuario no se combinarán.

Requisitos previos

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

Límite de velocidad

Cuerpo de la solicitud

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

1
2
3
4
5
6
{
   "aliases_to_identify" : (required, array of alias to identify objects),
   "emails_to_identify": (optional, array of string) User emails to identify,
   "phone_numbers_to_identify": (optional, array of string) User phone numbers to identify,
   "merge_behavior": (optional, string) one of 'none' or 'merge' is expected
}

Parámetros de la solicitud

Puedes añadir hasta 50 alias de usuario por solicitud. Puedes asociar varios alias de usuario adicionales a un único external_id.

Campo Comportamiento_fusión

Si configuras el campo merge_behavior como merge, el punto final fusionará la siguiente lista de campos que se encuentran exclusivamente en el usuario anónimo con el usuario identificado. Si configuras el campo como none, no se fusionará ningún dato de usuario con el perfil de usuario identificado. Por predeterminado, este campo se establecerá en merge.

Identificador de usuarios por correo electrónico

Si se especifica un email como identificador, debes incluir también prioritization en el identificador. prioritization debe ser una matriz que especifique qué usuario fusionar si se encuentran varios usuarios. prioritization es una matriz ordenada, lo que significa que si más de un usuario coincide a partir de una priorización, no se producirá la fusión.

Los valores permitidos para la matriz son:

• identified
• unidentified
• most_recently_updated (se refiere a dar prioridad al usuario actualizado más recientemente)
• least_recently_updated (se refiere a dar prioridad al usuario que se haya actualizado menos recientemente)

En la matriz de priorización solo puede existir una de las siguientes opciones a la vez:

• identified se refiere a dar prioridad a un usuario con un external_id
• unidentified se refiere a dar prioridad a un usuario sin un external_id

Si especificas identified en la matriz, significaría que el usuario debe tener un external_id para poder entrar en el Canvas. Si quieres que los usuarios con direcciones de correo electrónico introduzcan el mensaje, independientemente de si están identificados o no, utiliza en su lugar el parámetro most_recently_updated o least_recently_updated.

Ejemplo de solicitud

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
curl --location --request POST 'https://rest.iad-01.braze.com/users/identify' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--data-raw '{
  "aliases_to_identify": [
    {
      "external_id": "external_identifier",
      "user_alias": {
          "alias_name": "example_alias",
          "alias_label": "example_label"
      }
    }
  ],
  "emails_to_identify": [
    {
      "external_id": "external_identifier_2",
      "email": "[email protected]",
      "prioritization": ["unidentified", "most_recently_updated"]
    }
  ]
  "merge_behavior": "merge"
}'

Respuesta

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