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, ou braze_ids podem ser incluídos em uma única solicitação. Apenas uma das opções external_ids, user_aliases ou braze_ids pode ser incluída em uma única solicitação.

Pré-requisitos

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

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/alias/new, /users/identify, and /users/merge 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
{
  "external_ids" : (optional, array of string) External ids for the users to delete,
  "user_aliases" : (optional, array of user alias objects) User aliases for the users to delete,
  "braze_ids" : (optional, array of string) Braze user identifiers for the users to delete
}

Parâmetros de solicitação

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 uma external_id
• unidentified refere-se à priorização de um usuário sem um external_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": "john.smith@braze.com",
      "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
}