Borrar usuarios

Utiliza este punto final para eliminar cualquier perfil de usuario especificando un identificador de usuario conocido.

Se pueden incluir hasta 50 external_ids, user_aliases, braze_ids, email_addresses, o phone_numbers en una sola solicitud. Sólo se puede incluir una de las siguientes opciones en una misma solicitud: external_ids, user_aliases, braze_ids, email_addresses, o phone_numbers.

Si tienes un caso de uso que no puede resolverse con la eliminación masiva de usuarios a través de la API, ponte en contacto con el equipo de soporte de Braze para obtener ayuda.

Requisitos previos

Para utilizar este punto final, necesitarás una clave de API con el permiso users.delete.

Límite de velocidad

Cuerpo de la solicitud

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 la solicitud

Eliminar usuarios por correo electrónico

Si se especifica un email como identificador, se requiere un valor prioritization adicional en el identificador. La prioritization es una matriz ordenada y debe especificar qué usuario eliminar si se encuentran varios usuarios. Esto significa que la eliminación de usuarios no se producirá si más de un usuario coincide con una priorización.

Los valores permitidos para la matriz son: identified, unidentified, most_recently_updated. most_recently_updated se refiere a dar prioridad al usuario actualizado más recientemente.

En la matriz de priorización solo puede existir una de las siguientes opciones a la vez:

• identified se refiere a dar prioridad a un usuario con un external_id
• unidentified se refiere a dar prioridad a un usuario sin un external_id

Ejemplo de solicitud

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"]
    }
  ]
}'

Respuesta

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
}