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 users/identify.

A criação de um novo usuário somente de alias exige que o endereç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 atribuições, eventos e compras, e o endpoint /users/identify para identificar o usuário com um external_id.

Pré-requisitos

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

Limite de taxa

For customers who onboarded with Braze on or after September 16, 2021, 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/identify, /users/merge, and /users/alias/update endpoints, as documented in API rate limits.

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 nova especificação de 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

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