Atualizar o alias do usuário

Use esse endpoint para atualizar os aliases de usuário existentes.

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

A atualização de um alias de usuário exige que alias_label, old_alias_name e new_alias_name sejam incluídos no objeto de atualização de alias do usuário. Se não houver um alias de usuário associado a alias_label e old_alias_name, nenhum alias será atualizado. Se o alias_label e o old_alias_name fornecidos forem encontrados, o old_alias_name será atualizado para o new_alias_name.

Pré-requisitos

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

Limite de taxa

Aplicamos um limite de frequência compartilhada de 20.000 solicitações por minuto a esse endpoint. Esse limite de frequência é compartilhado com os endpoints /users/delete, /users/alias/new, /users/identify e /users/merge, 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
{
  "alias_updates" : (required, array of update user alias object)
}

Parâmetros de solicitação

Corpo da solicitação de endpoint com especificação de objeto de alias de usuário atualizado

1
2
3
4
5
{
  "alias_label" : (required, string),
  "old_alias_name" : (required, string),
  "new_alias_name" : (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/update' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--data-raw '{
  "alias_updates" :[
    {
      "alias_label": "example_alias_label",
      "old_alias_name" : "example_old_alias_name",
      "new_alias_name" : "example_new_alias_name"
    }
  ]
}'