Criar novo alias de usuário

Use esse endpoint para adicionar novos aliases de usuário para usuários identificados existentes ou para criar novos usuários não identificados.

Podem ser especificados até 50 aliases de usuário por solicitação.

A adição de um alias de usuário para um usuário existente requer que um external_id seja incluído no novo objeto de alias de usuário. Se o external_id estiver presente no objeto, mas não houver nenhum usuário com esse external_id, o alias não será adicionado a nenhum usuário. Se um external_id não estiver presente, um usuário ainda será criado, mas precisará ser identificado posteriormente. Você pode fazer isso usando o endpoint “Identificação de usuários” e o endpoint users/identify.

A criação de um novo usuário somente de alias exige que o external_id seja omitido no novo objeto de alias de usuário. Depois que o usuário for criado, use o endpoint /users/track para associar o usuário somente de alias a atributos, eventos e compras, e o endpoint /users/identify para identificar o usuário com um external_id.

Quando alias_label e alias_name já existem

A combinação de alias_label e alias_name deve ser única em toda a sua base de usuários. Para saber mais, consulte Aliases de usuário.

Se você enviar uma solicitação em que o par alias_label e alias_name já existe para qualquer usuário (seja no mesmo usuário ou em outro), o endpoint ainda retornará uma resposta de sucesso (por exemplo, "aliases_processed": 1, "message": "success"). Nesse caso, nenhum novo alias é adicionado ao usuário na solicitação. Como o par alias_label e alias_name já está em uso, a solicitação não faz nenhuma alteração, e pode parecer que o alias nunca foi adicionado ao usuário em questão.

Pré-requisitos

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

Limite de taxa

Aplicamos um limite de taxa compartilhado de 20.000 solicitações por minuto a esse endpoint. Esse limite de taxa é compartilhado com os endpoints /users/delete, /users/identify, /users/merge e /users/alias/update, conforme documentado em Limites de taxa da API.

Corpo da solicitação

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 solicitação

Corpo da solicitação do endpoint com a especificação do novo objeto de alias de usuário

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

Exemplo de solicitação

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

Resposta

Quando um alias é ignorado porque o mesmo alias_label e alias_name já existem para um usuário, o corpo da resposta ainda pode indicar sucesso. Consulte Quando alias_label e alias_name já existem para mais detalhes.

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