Skip to content

Consultar correos electrónicos de rebote duro

get

/email/hard_bounces

Utiliza este punto de conexión para obtener una lista de direcciones de correo electrónico que han tenido un “rebote duro” en tus mensajes de correo electrónico dentro de un periodo de tiempo determinado.

Requisitos previos

Para utilizar este punto de conexión, necesitarás una clave de API con el permiso email.hard_bounces.

Límite de velocidad

Aplicamos el límite de velocidad predeterminado de Braze de 250 000 solicitudes por hora a este punto de conexión, como se documenta en Límites de velocidad de la API.

Parámetros de la solicitud

Parámetro Obligatorio Tipo de datos Descripción
start_date Opcional* Cadena en formato AAAA-MM-DD *Se requiere start_date o email. Es la fecha de inicio del intervalo para recuperar rebotes duros y debe ser anterior a end_date. La API la considera medianoche en hora UTC.
end_date Obligatorio Cadena en formato AAAA-MM-DD Fecha de finalización del intervalo para recuperar rebotes duros. La API la considera medianoche en hora UTC.
limit Opcional Número entero Campo opcional para limitar el número de resultados devueltos. De forma predeterminada es 100, el máximo es 500.
offset Opcional Número entero Punto de inicio opcional de la lista desde el que recuperar.
email Opcional* Cadena *Se requiere start_date o email. Si se proporciona, devolveremos si el usuario ha tenido un rebote duro o no. Comprueba que las cadenas de correo electrónico tienen el formato adecuado.

Si tu intervalo de fechas tiene más del número limit de rebotes duros, tendrás que hacer varias llamadas a la API, aumentando cada vez el offset hasta que una llamada devuelva menos de limit o cero resultados. Incluir los parámetros offset y limit con email puede devolver una respuesta vacía.

Ejemplo de solicitud

1
2
curl --location --request GET 'https://rest.iad-01.braze.com/email/hard_bounces?start_date=2019-01-01&end_date=2019-02-01&limit=100&offset=1' \
--header 'Authorization: Bearer YOUR-API-KEY-HERE'

Respuesta

Las entradas aparecen en orden descendente.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
  "emails": [
    {
      "email": (string) an email that has hard bounced,
      "hard_bounced_at": (string) the time the email hard bounced in ISO 8601
    },
    {
      "email": (string) an email that has hard bounced,
      "hard_bounced_at": (string) the time the email hard bounced in ISO 8601
    },
    {
      "email": (string) an email that has hard bounced,
      "hard_bounced_at": (string) the time the email hard bounced in ISO 8601
    }
  ],
  "message": "success"
}
New Stuff!