Excluir usuários
Use esse endpoint para excluir qualquer perfil de usuário, especificando um identificador de usuário conhecido.
Até 50 external_ids
, user_aliases
, braze_ids
, email_addresses
, ou phone_numbers
podem ser incluídos em uma única solicitação. Somente um dos sites external_ids
, user_aliases
, braze_ids
, email_addresses
ou phone_numbers
pode ser incluído em uma única solicitação.
Se tiver um caso de uso que não possa ser resolvido com a exclusão de usuários em massa por meio da API, entre em contato com a equipe de suporte da Braze para obter assistência.
A exclusão de perfis de usuário não pode ser desfeita. Ele removerá permanentemente os usuários que possam causar discrepâncias nos seus dados. Saiba mais sobre o que acontece quando você exclui um perfil de usuário usando a API em nossa documentação de Ajuda.
Pré-requisitos
Para usar esse endpoint, você precisará de uma chave de API com a permissão users.delete
.
Limite de taxa
We apply a shared rate limit of 20,000 requests per minute to this endpoint. This rate limit is shared with the /users/alias/new
, /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
4
5
6
7
{
"external_ids" : (optional, array of string) External IDs to be deleted,
"user_aliases" : (optional, array of user alias objects) User aliases to be deleted,
"braze_ids" : (optional, array of string) Braze user identifiers to be deleted,
"email_addresses": (optional, array of string) User emails to be deleted,
"phone_numbers": (optional, array of string) User phone numbers to be deleted
}
Parâmetros de solicitação
Parâmetro | Obrigatória | Tipo de dados | Descrição |
---|---|---|---|
external_ids |
Opcional | Matriz de strings | Identificadores externos a serem excluídos. |
user_aliases |
Opcional | Vetor de objeto de alias de usuário | Aliases de usuário a serem excluídos. |
braze_ids |
Opcional | Matriz de strings | Identificadores de usuário do Braze a serem excluídos. |
email_addresses |
Opcional | Matriz de strings | E-mails de usuários a serem excluídos. Para saber mais, consulte Exclusão de usuários por e-mail. |
phone_numbers |
Opcional | Matriz de strings | Números de telefone do usuário a serem excluídos. |
Exclusão de usuários por e-mail
Se um email
for especificado como um identificador, um valor prioritization
adicional será necessário no identificador. O prioritization
é uma matriz ordenada e deve especificar qual usuário deve ser excluído se forem encontrados vários usuários. Isso significa que a exclusão de usuários não ocorrerá se mais de um usuário corresponder a uma priorização.
Os valores permitidos para o vetor são: identified
, unidentified
, most_recently_updated
. most_recently_updated
refere-se à priorização do usuário atualizado mais recentemente.
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 umaexternal_id
unidentified
refere-se à priorização de um usuário sem umexternal_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/delete' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--data-raw '{
"external_ids": ["external_identifier1", "external_identifier2"],
"braze_ids": ["braze_identifier1", "braze_identifier2"],
"user_aliases": [
{
"alias_name": "user_alias1", "alias_label": "alias_label1"
},
{
"alias_name": "user_alias2", "alias_label": "alias_label2"
}
],
"email_addresses": [
{
"email": "[email protected]",
"prioritization": ["unidentified", "most_recently_updated"]
}
]
}'
Resposta
1
2
3
4
5
Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY
{
"deleted" : (required, integer) number of user IDs queued for deletion
}