Consulta de e-mails hard bounce
/email/hard_bounces
Use esse ponto de extremidade para obter uma lista de endereços de e-mail que sofreram “hard bounce” em suas mensagens de e-mail em um determinado período de tempo.
Pré-requisitos
Para usar esse endpoint, você precisará de uma chave de API com a permissão email.hard_bounces
.
Limite de taxa
We apply the default Braze rate limit of 250,000 requests per hour to this endpoint, as documented in API rate limits.
Parâmetros de solicitação
Parâmetro | Obrigatória | Tipo de dados | Descrição |
---|---|---|---|
start_date |
Opcional (ver nota) |
String no formato YYYY-MM-DD | A data de início do intervalo para recuperar hard bounce deve ser anterior a end_date . Isso é tratado como meia-noite no horário UTC pela API. |
end_date |
Opcional (ver nota) |
String no formato YYYY-MM-DD | Data final do intervalo para recuperar hard bounces. Isso é tratado como meia-noite no horário UTC pela API. |
limit |
Opcional | Inteiro | Campo opcional para limitar o número de resultados retornados. O padrão é 100, o máximo é 500. |
offset |
Opcional | Inteiro | Ponto inicial opcional na lista a ser recuperado. |
email |
Opcional (ver nota) |
String | Se fornecido, retornaremos se o usuário sofreu hard bounce ou não. Verifique se as strings de e-mail estão formatadas corretamente. |
Você precisa fornecer um start_date
e end_date
, OU um email
. Se você fornecer todos os três, start_date
, end_date
, e um email
, priorizaremos os e-mails fornecidos e desconsideraremos o intervalo de datas.
Se o seu intervalo de datas tiver mais do que o número limit
de hard bounces, será necessário fazer várias chamadas à API, aumentando a cada vez o offset
até que uma chamada retorne menos do que limit
ou zero resultados. A inclusão dos parâmetros offset
e limit
com email
pode retornar uma resposta vazia.
Exemplo de solicitação
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'
Resposta
As entradas são listadas em ordem decrescente.
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,
"unsubscribed_at": (string) the time the email hard bounced in ISO 8601
},
{
"email": (string) an email that has hard bounced,
"unsubscribed_at": (string) the time the email hard bounced in ISO 8601
},
{
"email": (string) an email that has hard bounced,
"unsubscribed_at": (string) the time the email hard bounced in ISO 8601
}
],
"message": "success"
}