Eliminar usuarios

Utiliza este punto de conexión 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. Solo 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 de conexión, necesitarás una clave de API con el permiso users.delete.

Límite de velocidad

Aplicamos un límite de velocidad compartido de 20 000 solicitudes por minuto a este punto final. Este límite de velocidad se comparte con los puntos finales /users/alias/new, /users/identify, /users/merge y /users/alias/update, como se documenta en Límites de velocidad de la API.

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 direcciones de correo electrónico y números de teléfono

Si se especifica una dirección de correo electrónico o un número de teléfono como identificador, se requiere un valor adicional prioritization en el identificador. prioritization debe ser una matriz ordenada y debe especificar qué usuario eliminar si hay 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 (se refiere a dar prioridad al usuario actualizado más recientemente)

En la matriz prioritization 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
{
  "deleted" : (required, integer) number of user IDs queued for deletion
}

Solución de problemas

Se devolvió una respuesta correcta, pero el usuario sigue apareciendo

Una respuesta correcta confirma que la solicitud se puso en cola, no que la eliminación se haya completado. La eliminación suele finalizar en menos de un segundo, pero puede tardar hasta cinco minutos en propagarse a todas las cachés. Si buscas al usuario inmediatamente en el dashboard o exportas sus datos a través de la API, es posible que aún veas resultados durante esta ventana de propagación.

Si el usuario sigue existiendo después de varios minutos, verifica que el identificador de tu solicitud coincida con el perfil real del usuario:

• Matriz external_ids: Confirma que cada valor coincide exactamente con el ID externo de un usuario.
• braze_id: Puedes encontrar el braze_id de un usuario exportando sus datos con el punto de conexión /users/export/ids o exportando un segmento a CSV (donde el braze_id aparece como “Appboy ID”).
• Perfiles solo con alias o solo con correo electrónico: Si el perfil no tiene external_id, crea un segmento filtrando por El ID de usuario externo está en blanco combinado con el correo electrónico o número de teléfono conocido, y luego exporta a CSV para obtener el braze_id.

Para confirmar si un usuario ha sido eliminado, llama al punto de conexión /users/export/ids utilizando el mismo tipo de identificador que usaste en la solicitud de eliminación (por ejemplo, incluyendo el valor en external_ids, braze_id o user_aliases). Si el usuario ya no existe, la respuesta contiene "users": [] y puede incluir "invalid_user_ids" con ese identificador.