Consultar correos electrónicos de rebote duro
/email/hard_bounces
Utiliza este punto final para obtener una lista de direcciones de correo electrónico que han “rebotado duramente” tus mensajes de mensajería en un plazo de tiempo determinado.
Requisitos previos
Para utilizar este punto final, 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 final, como se documenta en Límites de velocidad de la API.
Parámetros de la solicitud
Parámetro | Obligatoria | Tipo de datos | Descripción |
---|---|---|---|
start_date |
Opcional (ver nota) |
Cadena en formato AAAA-MM-DD | Fecha de inicio del rango para recuperar rebotes duros, debe ser anterior a end_date . La API lo considera medianoche en hora UTC. |
end_date |
Opcional (ver nota) |
Cadena en formato AAAA-MM-DD | Fecha de finalización del intervalo para recuperar rebotes duros. La API lo considera medianoche en hora UTC. |
limit |
Opcional | Entero | Campo opcional para limitar el número de resultados devueltos. De forma predeterminada, 100, el máximo es 500. |
offset |
Opcional | Entero | Punto de inicio opcional de la lista a recuperar. |
email |
Opcional (ver nota) |
Cadena | Si se proporciona, devolveremos si el usuario es un rebote duro o no. Comprueba que las cadenas de correo electrónico tienen el formato adecuado. |
Debes proporcionar o bien un start_date
y un end_date
, O bien un email
. Si proporcionas los tres, start_date
, end_date
y un email
, damos prioridad a los correos electrónicos proporcionados y no tenemos en cuenta el intervalo de fechas.
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&[email protected]' \
--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
18
19
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
"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"
}