Identificar usuários

Use este endpoint para identificar um usuário não identificado (apenas por alias, apenas por e-mail ou apenas por número de telefone) usando o ID externo fornecido.

Como funciona?

Chamar /users/identify combina um perfil de usuário que é identificado por um alias (perfil apenas por alias), endereço de e-mail (perfil apenas por e-mail) ou número de telefone (perfil apenas por número de telefone) com um perfil de usuário que tem um external_id (perfil identificado), e então remove o perfil apenas por alias.

Identificar um usuário requer que um external_id seja incluído nos seguintes objetos:

• aliases_to_identify
• emails_to_identify
• phone_numbers_to_identify

Se não houver um usuário com esse external_id, o external_id é adicionado ao registro do usuário com alias, e o usuário é considerado identificado. Os usuários podem ter apenas um alias para um rótulo específico. Se um usuário já existir com o external_id e tiver um alias existente com o mesmo rótulo que o perfil apenas por alias, então os perfis de usuário não são combinados.

Comportamento de mesclagem

Por padrão, este endpoint mescla a seguinte lista de campos encontrados exclusivamente no usuário anônimo para o usuário identificado.

Pré-requisitos

Para usar esse endpoint, você precisará de uma chave de API com a permissão users.identify.

Limite de taxa

Aplicamos um limite de taxa compartilhado de 20.000 solicitações por minuto para este endpoint. Esse limite de frequência é compartilhado com os endpoints /users/delete, /users/alias/new, /users/merge e /users/alias/update, conforme documentado em Limites de frequência da API.

Corpo da solicitação

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

1
2
3
4
5
{
   "aliases_to_identify" : (required, array of alias to identify objects),
   "emails_to_identify": (optional, array of alias to identify objects) User emails to identify,
   "phone_numbers_to_identify": (optional, array of alias to identify objects) User phone numbers to identify,
},

Parâmetros de solicitação

É possível adicionar até 50 aliases de usuário por solicitação. É possível associar vários aliases de usuário adicionais a um único external_id.

Identificando usuários por endereços de e-mail e números de telefone

Se um endereço de e-mail ou número de telefone for especificado como um identificador, você também deve incluir prioritization no identificador.

O prioritization deve ser um array especificando qual usuário mesclar se houver vários usuários encontrados. prioritization é um array ordenado, o que significa que se mais de um usuário corresponder a uma priorização, a mesclagem não ocorrerá.

Os valores permitidos para o array são:

• identified
• unidentified
• most_recently_updated (refere-se a priorizar o usuário mais recentemente atualizado)
• least_recently_updated (refere-se a priorizar o usuário menos recentemente atualizado)

Somente uma das opções a seguir pode existir na matriz de priorização por vez:

• identified refere-se à priorização de um usuário com uma external_id
• unidentified refere-se à priorização de um usuário sem um external_id

Exemplo de solicitação

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
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"]
    }
  ]
}'

Resposta

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