Excluir usuários

Use este endpoint para excluir qualquer perfil de usuário especificando um identificador de usuário conhecido.

Você pode incluir até 50 external_ids, user_aliases, braze_ids, email_addresses ou phone_numbers em uma única solicitação. Cada solicitação só pode conter um tipo de identificador: external_ids, user_aliases, braze_ids, email_addresses ou phone_numbers.

Se você tiver um caso de uso que não possa ser resolvido com a exclusão de usuários em massa pela API, entre em contato com a equipe de suporte da Braze para obter ajuda.

Aviso

A exclusão de perfis de usuário não pode ser desfeita. A ação de exclusão remove os usuários permanentemente, o que pode causar discrepâncias nos seus dados. Para saber mais, consulte a seção Efeitos da exclusão de perfis de usuário na referência deste endpoint.

Solução de problemas

Uma resposta de sucesso foi retornada, mas o usuário ainda aparece

Uma resposta de sucesso confirma que a solicitação entrou na fila, não que a exclusão foi concluída. A exclusão normalmente termina em menos de um segundo, mas pode levar até cinco minutos para a alteração se propagar por todos os caches. Se você pesquisar o usuário no dashboard ou exportar os dados dele pela API logo em seguida, ainda poderá ver resultados durante esse período de propagação.

Se o usuário ainda existir depois de vários minutos, verifique se o identificador na sua solicitação corresponde ao perfil real do usuário:

• Array external_ids: Confirme que cada valor corresponde exatamente ao ID externo de um usuário.
• braze_id: Você pode encontrar o braze_id de um usuário exportando os dados dele com o endpoint /users/export/ids ou exportando um Segment para CSV (no qual o braze_id aparece como “Appboy ID”).
• Perfis somente com alias ou somente com e-mail: Se o perfil não tiver external_id, crie um Segment filtrando por External User ID is blank combinado com o e-mail ou número de telefone conhecido. Depois, exporte para CSV para obter o braze_id.

Para confirmar se um usuário foi excluído, chame o endpoint /users/export/ids usando o mesmo tipo de identificador que você usou na solicitação de exclusão (por exemplo, incluindo o valor em external_ids, braze_id ou user_aliases). Se o usuário não existir mais, a resposta conterá "users": [] e poderá incluir "invalid_user_ids" listando esse identificador.

Você pode baixar o documento OpenAPI e usá-lo para validar esquemas. Para saber como, consulte Usar esquemas OpenAPI para validação de solicitações.